你如何在 php 中创建可选参数？

Question

在 PHP 手册中，为了显示带有可选参数的函数的语法，他们在每组相关可选参数周围使用括号。 例如，对于date()函数，手册上写着：

string date ( string $format [, int $timestamp = time() ] )

其中$timestamp是一个可选参数，当留空时它默认为time()函数的返回值。

在 PHP 中定义自定义函数时，您如何创建这样的可选参数？

Answer 1

与手册非常相似，在参数定义中使用等号（ = ）：

function dosomething($var1, $var2, $var3 = 'somevalue'){
    // Rest of function here...
}

Answer 2

参数的默认值必须是常量表达式。 它不能是变量或函数调用。

但是，如果您需要此功能：

function foo($foo, $bar = false)
{
    if(!$bar)
    {
        $bar = $foo;
    }
}

假设$bar当然不是布尔值。

Answer 3

我发现有用的一些注意事项：

• 保持默认值在右侧。

   function whatever($var1, $var2, $var3="constant", $var4="another") 

• 参数的默认值必须是常量表达式。 它不能是变量或函数调用。

Answer 4

为可选参数指定默认值。

function date ($format, $timestamp='') {
}

Answer 5

日期函数将定义如下：

function date($format, $timestamp = null)
{
    if ($timestamp === null) {
        $timestamp = time();
    }

    // Format the timestamp according to $format
}

通常，您会将默认值设置为：

function foo($required, $optional = 42)
{
    // This function can be passed one or more arguments
}

但是，只有文字是有效的默认参数，这就是为什么我在第一个例子中使用null作为默认参数， 而不是 $timestamp = time() ，并将其与空检查结合起来。 文字包括数组（ array()或[] ），布尔值，数字，字符串和null 。

Answer 6

如果您不知道需要处理多少属性，可以使用PHP 5.6中引入的variadic参数列表标记（ ... ）（ 请参阅此处的完整文档 ）。

句法：

function <functionName> ([<type> ]...<$paramName>) {}

例如：

function someVariadricFunc(...$arguments) {
  foreach ($arguments as $arg) {
    // do some stuff with $arg...
  }
}

someVariadricFunc();           // an empty array going to be passed
someVariadricFunc('apple');    // provides a one-element array
someVariadricFunc('apple', 'pear', 'orange', 'banana');

如您所见，此令牌基本上将所有参数转换为数组，您可以以您喜欢的任何方式处理该数组。

Answer 7

从 7.1 开始，有一个可空参数的类型提示

function func(?Object $object) {}

它将适用于这些情况：

func(null); //as nullable parameter
func(new Object());  // as parameter of declared  type

但是对于可选值签名应该是这样的。

function func(Object $object = null) {} // In case of objects
function func(?Object $object = null) {} // or the same with nullable parameter

function func(string $object = '') {} // In case of scalar type - string, with string value as default value
function func(string $object = null) {} // In case of scalar type - string, with null as default value
function func(?string $object = '') {} // or the same with nullable parameter

function func(int $object = 0) {} // In case of scalar type - integer, with integer value as default value
function func(int $object = null) {} // In case of scalar type - integer, with null as default value
function func(?int $object = 0) {} // or the same with nullable parameter

比它可以调用为

func(); // as optional parameter
func(null); // as nullable parameter
func(new Object()); // as parameter of declared type