各関数についてクイックリファレンスが記述されているので、 マニュアルを読み理解するノウハウは PHP の利用をより簡単にしてくれます。 例示やカットアンドペーストに頼るより、関数の定義(プロトタイプ)を 読む方法を覚えるべきです。やってみましょう:
関数の定義には返り値が どんな型であるかが示されています。最初の例として、 strlen()の定義を考えてみましょう。
strlen (PHP 3, PHP 4, PHP 5) strlen -- 文字列の長さを得る 説明 int strlen ( string str ) 文字列の長さを返します |
表 R-1. 関数の定義の説明
Part | 説明 |
---|---|
strlen | 関数の名前 |
(PHP 3, PHP 4, PHP 5) | strlen()は PHP 3 と PHP 4 の両方で使用できる |
int | 関数が戻す値の型。ここでは整数 (文字列の長さが数字で数えら得ている) |
( string str ) | strlen() 関数の最初の(この場合は唯一の)引数が strという名前であり それは文字列である |
上の関数定義は、一般的な書き方では以下のようにも書けます。
returned type function name ( parameter type parameter name ) |
多くの関数は複数の引数を取ります。例えば in_array()。 このプロトタイプは次のようになります:
bool in_array ( mixed needle, array haystack [, bool strict]) |
これは何を意味しているのでしょう? in_array() は boolean の値を返します。 成功した場合は TRUE(needle が haystack の中にある場合)、失敗した場合は FALSE (needle が haystack の中にない場合)です。最初の引数は needle と名づけられており、それは多くの違った 型をとることができます。その場合"mixed"と 呼ばれます。 needle (我々が探しているもの)はスカラー値(文字列,整数, 又は float)でも、 配列でもかまいません。 haystack (対象を探す配列)は二番目の引数です。 三番目のオプションの引数は strict と名づけられています。全てのオプション引数は [ ブラケット ]の中に表現されます。 strict パラメータはデフォルトでは boolean の FALSE であるとマニュアルに述べられています。機能の詳細については 各関数のマニュアルをご覧ください。
より複雑なバージョンとの関係を有する関数もあります。以下が html_entity_decode() の例です。
(PHP 4 >= 4.3.0, PHP 5) |
これは、この関数は PHP 3 では利用できず、 PHP 4.3.0 以降のバージョンでのみ利用可能であることを意味します。