带有可选参数的PHP函数

我编写了一个PHP函数，该函数可以接受10个参数，但仅需要2个。有时，我想定义第八个参数，但是在到达第八个参数之前，我不想为每个参数键入空字符串。

我的一个想法是传递带有参数数组的抽象函数，并将其传递给实际函数。

有没有更好的方法来设置函数，以便我只能传递我想要的参数？

使函数采用一个参数：数组。将实际参数作为数组中的值传递。

编辑： Pekka的评论中的链接仅作总结。

在这种情况下，我要做的是传递一个数组，其中的键是参数名称，而值是值。

$optional = array(
  "param" => $param1,
  "param2" => $param2
);

function func($required, $requiredTwo, $optional) {
  if(isset($optional["param2"])) {
    doWork();
  }
}

要完成所需的操作，请使用Rabbot所说的数组（但是如果使用过多，这可能会很难记录/维护）。或者只使用传统的可选参数。

//My function with tons of optional params
function my_func($req_a, $req_b, $opt_a = NULL, $opt_b = NULL, $opt_c = NULL)
{
  //Do stuff
}
my_func('Hi', 'World', null, null, 'Red');

但是，我通常会发现，当我开始编写具有这么多参数的函数/方法时-通常不是代码异味，并且可以将其重构/抽象为更整洁的东西。

//Specialization of my_func - assuming my_func itself cannot be refactored
function my_color_func($reg_a, $reg_b, $opt = 'Red')
{
  return my_func($reg_a, $reg_b, null, null, $opt);
}
my_color_func('Hi', 'World');
my_color_func('Hello', 'Universe', 'Green');

在PHP 5.6和更高版本中，参数列表可能包含...令牌，以表示该函数接受可变数量的参数。参数将作为数组传递到给定变量中；例如：

使用...访问变量参数的示例

<?php
function sum(...$numbers) {
    $acc = 0;
    foreach ($numbers as $n) {
        $acc += $n;
    }
    return $acc;
}

echo sum(1, 2, 3, 4);
?>

上面的示例将输出：

10

变长参数列表PHP文档

您可以将默认值设置为null。

<?php
function functionName($value, $value2 = null) {
// do stuff
}

注意：这是旧的答案，适用于PHP 5.5及以下版本。PHP 5.6+支持默认参数

在PHP 5.5及更低版本中，您可以使用以下两种方法之一来实现此目的：

• 使用func_num_args（）和func_get_arg（）函数；
• 使用NULL参数；

如何使用

function method_1()
{
  $arg1 = (func_num_args() >= 1)? func_get_arg(0): "default_value_for_arg1";
  $arg2 = (func_num_args() >= 2)? func_get_arg(1): "default_value_for_arg2";
}

function method_2($arg1 = null, $arg2 = null)
{
  $arg1 = $arg1? $arg1: "default_value_for_arg1";
  $arg2 = $arg2? $arg2: "default_value_for_arg2";
}

我喜欢第二种方法，因为它很干净而且易于理解，但是有时您可能需要第一种方法。

我认为，您也可以将对象用作参数传输。

$myParam = new stdClass();
$myParam->optParam2 = 'something';
$myParam->optParam8 = 3;
theFunction($myParam);

function theFunction($fparam){      
  return "I got ".$fparam->optParam8." of ".$fparam->optParam2." received!";
}

当然，您必须在此函数中为“ optParam8”和“ optParam2”设置默认值，否则，您将获得“ Notice：Undefined property：stdClass :: $ optParam2”

如果使用数组作为函数参数，我喜欢这种方式来设置默认值：

function theFunction($fparam){
   $default = array(
      'opt1' => 'nothing',
      'opt2' => 1
   );
   if(is_array($fparam)){
      $fparam = array_merge($default, $fparam);
   }else{
      $fparam = $default;
   }
   //now, the default values are overwritten by these passed by $fparam
   return "I received ".$fparam['opt1']." and ".$fparam['opt2']."!";
}

如果只需要两个值即可创建具有有效状态的对象，则可以简单地删除所有其他可选参数并为其提供设置器（除非您不希望它们在运行时更改）。然后只需使用两个必需的参数实例化该对象，然后根据需要通过setter设置其他参数。

进一步阅读

• 马丁·福勒（Martin Fowler）关于构造函数与二传手注入和
• 通过构造函数或属性设置器进行依赖注入？

我知道这是一篇旧文章，但是我遇到了像OP这样的问题，这就是我想出的。

您可以通过的数组示例。如果需要特定的订单，可以重新订购，但是对于这个问题，它将按照要求进行。

$argument_set = array (8 => 'lots', 5 => 'of', 1 => 'data', 2 => 'here');

这是易于管理的，易于阅读的，并且可以在编码中的任何位置立即添加和删除数据提取点，并且仍然避免大量重写。我使用整数键来计算OP原始问题，但是可以很容易地使用字符串键。实际上，出于可读性考虑，我会建议这样做。

轻松粘贴到外部文件中

function unknown_number_arguments($argument_set) {

    foreach ($argument_set as $key => $value) {

        # create a switch with all the cases you need. as you loop the array 
        # keys only your submitted $keys values will be found with the switch. 
        switch ($key) {
            case 1:
                # do stuff with $value
                break;
            case 2:
                # do stuff with $value;
                break;
            case 3:
                # key 3 omitted, this wont execute 
                break;
            case 5:
                # do stuff with $value;
                break;
            case 8:
                # do stuff with $value;
                break;
            default:
                # no match from the array, do error logging?
                break;
        }
    }
return;
}

如果是文件，则将其放在开头。

$argument_set = array(); 

只需使用这些来根据数据来自何处分配下一个数据使用编号/命名。

$argument_set[1][] = $some_variable; 

最后传递数组

unknown_number_arguments($argument_set);

function yourFunction($var1, $var2, $optional = Null){
   ... code
}

您可以创建一个常规函数，然后通过为它们提供默认的Null值来添加可选变量。

Null仍然是一个值，如果不使用该变量的值调用该函数，则该值不会为空，因此不会出错。

如果通常只传递第8个值，则可以重新排列参数，因此它是第一个。您只需要指定参数，直到最后一个要设置的参数即可。

如果使用不同的值，则有2个选项。

一种方法是创建一组包装函数，这些包装函数采用不同的参数，并在其他包装函数上设置默认值。如果您仅使用一些组合，但很快就会变得非常混乱，这很有用。

另一种选择是传递一个数组，其中键是参数的名称。然后，您可以只检查数组中是否有带键的值，如果不使用默认值。但是同样，如果您有很多参数，这可能会变得混乱并添加很多额外的代码。

PHP允许使用默认参数（link）。在您的情况下，您可以根据功能代码将3到8的所有参数定义为NULL或为空字符串“”。这样，您只能使用前两个参数来调用该函数。

例如：

<?php
  function yourFunction($arg1, $arg2, $arg3=NULL, $arg4=NULL, $arg5=NULL, $arg6=NULL, $arg7=NULL, $arg8=NULL){
echo $arg1;
echo $arg2;
if(isset($arg3)){echo $arg3;}
# other similar statements for $arg4, ...., $arg5
if(isset($arg8)){echo $arg8;}
}

只需将Null设置为忽略不需要的参数，然后根据位置设置所需的参数即可。

 function myFunc($p1,$p2,$p3=Null,$p4=Null,$p5=Null,$p6=Null,$p7=Null,$p8=Null){
    for ($i=1; $i<9; $i++){
        $varName = "p$i";
        if (isset($$varName)){
            echo $varName." = ".$$varName."<br>\n";
        }
    }
}   

myFunc( "1", "2", Null, Null, Null, Null, Null, "eight" );

func( "1", "2", default, default, default, default, default, "eight" );