如何閱讀函式的定義（函式原型）

文件中的每個函式都有快速參考，學會如何閱讀和理解文件將使得使用 PHP 更加簡單。和依賴把範例複製/貼上比起來，您一定更希望知道如何閱讀函式的定義（函式原型）：

Note: 先決條件：對“類型”的基本理解

盡管 PHP 是寬鬆型態(loosely typed)語言，但對“類型”有一個基本的理解也是非常重要的，因為它們有重要的意義。

函式定義告訴我們函式回傳什麼類型的值，讓我們用函式 strlen() 的定義作為我們的第一個範例：

strlen

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

Description
int strlen ( string $string )

Returns the length of given string.

我們可以將以上函式的定義寫成一般形式：

      returned type    function name    ( parameter type   parameter name )

很多函式都有多個參數，例如 in_array()。其函式原型如下：

      bool in_array ( mixed $needle, array $haystack [, bool $strict])

這是什麼意思？in_array() 回傳一個“布林”值，成功（即在參數 haystack 中能找到參數 needle）則回傳 TRUE 或者失敗（即在參數 haystack 中找不到參數 needle）則回傳 FALSE。第一個參數被命名為 needle 且其類型不定，因此我們將其稱為“混合”類型。該混合類型的 needle 參數（我們要找的對像）可以適一個純量的值（字串、整數、或者浮點），或者一個數組。haystack （我們尋找的範圍）是第二個參數。第三個選擇性參數被命名為 strict。所有的選擇性參數都用 [ 方括號 ] 引用。手冊表明 strict 參數預設值為布林值 FALSE。需要了解函式工作的細節，請參閱手冊中和該函式相關的頁面。

有一些函式帶有更複雜的 PHP 版本訊息。例如 html_entity_decode() ：

(PHP 4 >= 4.3.0, PHP 5)

這表示此函式在 PHP 3 中無法使用，而且只能用在 PHP 4.3.0 之後的版本。