如何解读函数定义(原型)

手册中的每个函数都经过了文档化,以便快速参考。了解如何阅读和理解文本将使学习 PHP 变得更加容易。与其依赖示例或剪切粘贴,每个人都应该知道如何阅读函数定义(原型)。让我们开始吧

注意: 先决条件:基本了解 类型

尽管 PHP 是一种弱类型语言,但了解 类型 的基本知识非常重要,因为它们具有重要的含义。

函数定义告诉我们返回值的类型。让我们使用 strlen() 的定义作为我们的第一个示例

strlen

(PHP 4, PHP 5, PHP 7)
strlen -- Get string length

Description
strlen ( string $string ) : int

Returns the length of given string.

函数定义的解释
部分 描述
strlen 函数名称。
(PHP 4、PHP 5、PHP 7) strlen() 在所有版本的 PHP 4、5 和 7 中都存在
( string $string ) 此函数的第一个(也是这种情况下的唯一一个)参数/参数名为 string,它是一个 字符串
int 此函数返回的值类型,它是一个 整数(即字符串的长度以数字衡量)。

我们可以以通用的方式重写上面的函数定义

      function name    ( parameter type   parameter name ) : returned type

许多函数接受多个参数,例如 in_array()。它的原型如下

      in_array ( mixed $needle, array $haystack , bool $strict = false ) : bool

这意味着什么?in_array() 返回一个 布尔 值,如果成功(如果在 haystack 中找到 needle),则为 true;如果失败(如果在 haystack 中未找到 needle),则为 false。第一个参数名为 needle,它可以是许多不同的 类型,因此我们称之为“混合”。此混合 needle(我们正在寻找的内容)可以是标量值(字符串、整数或 浮点数),也可以是 数组haystack(我们正在搜索的数组)是第二个参数。第三个可选参数名为 strict。所有可选参数都有默认值;如果默认值未知,则显示为 ?。手册指出 strict 参数默认为布尔 false。有关它们的工作原理的详细信息,请参阅每个函数的手册页。

此外,在函数参数前加 &(和号)符号允许将参数按 引用 传递,如下所示

       preg_match ( string $pattern , string $subject , array &$matches = null,
       int $flags = 0 , int $offset = 0 ) : int|false

在这个例子中,我们可以看到第三个可选参数 &$matches 将作为引用传递。

还有一些函数具有更复杂的 PHP 版本信息。以 html_entity_decode() 为例

(PHP 4 >= 4.3.0, PHP 5, PHP 7)

这意味着此函数仅在 PHP 4.3.0 之后的发布版本中才可用。

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top