函数开发

最困难的方面是决定如何将编程逻辑分解成函数。另一方面，在 PHP 中开发一个函数的机制非常简单。只需使用 function 关键字，给它起个名字，然后在后面加上括号。

如何做…

1.代码本身放在大括号中，如下所示：

  1. function someName ($parameter)
  2. { 
  3.   $result = 'INIT';
  4.   // 一个或多个影响 $result 的语句
  5.   $result .= ' and also ' . $parameter;
  6.   return $result; 
  7. }

2.您可以定义一个或多个参数。要使其中一个参数成为可选的，只需指定一个默认值。如果您不确定要分配什么默认值，请使用 NULL ：

  1. function someOtherName ($requiredParam, $optionalParam = NULL)
  2.   { 
  3.     $result = 0;
  4.     $result += $requiredParam;
  5.     $result += $optionalParam ?? 0;
  6.     return $result; 
  7.   }

{% hint style=”info” %} 您无法在同一命名空间下重复定义相同名称的函数。 此定义将产生错误：

  1. function someTest()
  2. {
  3.   return 'TEST';
  4. }
  5. function someTest($a)
  6. {
  7.   return 'TEST:' . $a;
  8. }

{% endhint %}

3.如果您不知道将为函数提供多少个参数，或者您想允许无限数量的参数时，请使用 ... 后面跟着一个变量名。 提供的所有参数将在变量中显示为数组：

  1. function someInfinite(...$params)
  2. {
  3.   // 任何传入的参数都会进入到 $params 数组中
  4.   return var_export($params, TRUE);
  5. }

4.一个函数可以调用自己。这就是所谓的递归。以下函数执行递归目录扫描：

  1. function someDirScan($dir)
  2. {
  3.   // 使用 "static" 来保持 $list 的值
  4.   static $list = array();
  5.   // 获取此路径的文件和目录列表
  6.   $list = glob($dir . DIRECTORY_SEPARATOR . '*');
  7.   // 遍历
  8.   foreach ($list as $item) {
  9.     if (is_dir($item)) {
  10.       $list = array_merge($list, someDirScan($item));
  11.     }
  12.   }
  13.   return $list;
  14. }

{% hint style=”info” %} static 关键字在函数中的使用在语言中已经超过12年了。 static 的作用是初始化变量一次（也就是在声明 static 的时候），然后在同一个请求中的函数调用之间保留其值。

如果你需要在 HTTP 请求之间保留一个变量的值，请确保 PHP 会话已经启动，并将该值存储在 $_SESSION 中。 {% endhint %}

5.当函数在 PHP 命名空间中定义时，函数是受限制的。这个特性可以被用来为函数库之间提供额外的逻辑分离。定义命名空间，您需要添加 use 关键字。 下面的例子被放置在不同的命名空间中。 请注意，即使函数名称相同，也不会发生冲突，因为它们彼此之间不可见。

6.我们在 Alpha 命名空间中定义了 someFunction() 。我们将其保存在一个单独的PHP文件中， chap_03_developing_functions_namespace_alpha.php ：

  1. <?php
  2. namespace Alpha;
  4. function someFunction()
  5. {
  6.   echo __NAMESPACE__ . ':' . __FUNCTION__ . PHP_EOL;
  7. }

7.然后我们在Beta 命名空间中定义 someFunction() 。我们将其保存到一个单独的PHP文件中， chap_03_developing_functions_namespace_beta.php ：

  1. <?php
  2. namespace Beta;
  4. function someFunction()
  5. {
  6.   echo __NAMESPACE__ . ':' . __FUNCTION__ . PHP_EOL;
  7. }

8.然后，我们可以在函数名前加上命名空间名来调用 someFunction() ：

  1. include (__DIR__ . DIRECTORY_SEPARATOR 
  2.          . 'chap_03_developing_functions_namespace_alpha.php');
  3. include (__DIR__ . DIRECTORY_SEPARATOR 
  4.          . 'chap_03_developing_functions_namespace_beta.php');
  5.       echo Alpha\someFunction();
  6.       echo Beta\someFunction();

{% hint style=”info” %} 最佳实践

最好的做法是将函数库（还有类！）放在单独的文件中：每个命名空间一个文件，每个文件一个类或函数库。

可以在单个命名空间中定义许多类或函数库。 之所以要开发成单独的命名空间，是因为希望促进功能的逻辑分离。 {% endhint %}

如何运行…

最好的做法是将所有逻辑上相关的函数放在一个单独的PHP文件中。创建一个名为 chap_03_developing_functions_library.php 的文件，并将这些函数（前面已经介绍过）放在里面：

  • someName()
  • someOtherName()
  • someInfinite()
  • someDirScan()
  • someTypeHint()

然后在使用这些函数的代码中包含这个文件。

  1. include (__DIR__ . DIRECTORY_SEPARATOR . 'chap_03_developing_functions_library.php');

要调用 someName() 函数，使用名称并提供参数。

  1. echo someName('TEST');   // 返回 "INIT and also TEST"

你可以使用一个或两个参数调用 someOtherName() 函数，如下。

  1. echo someOtherName(1);    // 返回  1
  2. echo someOtherName(1, 1);   // 返回 2

SomeInfinite() 函数接受无限（或可变）数量的参数。这里有几个调用这个函数的例子。

  1. echo someInfinite(1, 2, 3);
  2. echo PHP_EOL;
  3. echo someInfinite(22.22, 'A', ['a' => 1, 'b' => 2]);

输出结果是这样的：

函数开发 - 图1

我们可以如下调用 someInfinite() ：

  1. foreach (someDirScan(__DIR__ . DIRECTORY_SEPARATOR . '..') as $item) {
  2.     echo $item . PHP_EOL;
  3. }

输出结果如下：

函数开发 - 图2