PHPの公式マニュアルの読み方を解説します

PHP
スポンサーリンク

PHPの公式マニュアルが読めるメリット

PHP初心者が学習や何かを作ると言った時に関数を調べることがあると思います。

例えば、入門書にあるサンプルプログラムに出てくる関数の意味が分からなくて意味を調べたり、何かしらのプログラムを組んでいる時に便利な関数は無いかなーと調べたりしませんか。

こんな時ときに個人サイトでも良いと思いますが、公式マニュアル(公式リファレンス)を使うことにはメリットがあります。例えば以下のような感じです。

  • 記述が正確で漏れが無い
  • 情報が最新かつバージョンごとの情報がある
  • 検索機能がわりと便利

でも公式マニュアルってクセがあって読みにくいですよね。

もともとが英語なのでやはり翻訳に無理があったり、見慣れない記号があって分かりずらかったり、サイトデザインも堅苦しいですよね。

僕は上記のような理由で公式マニュアルを使うことを敬遠しがちだったのですが、やはりそれではいけないと思い、読み方を1通り確認しました。
今回はそれらをまとめていこうと思います。

それではpreg_match関数を例に読み方を確認していきます。

PHPの公式マニュアルの読み方

PHPの公式マニュアルには以下のような画像で書かれていると思います。

それでは上から1つずつ確認していきます。

PHP公式マニュアルでのバージョン確認

(PHP 4, PHP 5, PHP 7)

これはpreg_match()関数が使用できるPHPのバージョンを示しています。preg_match()はPHP4,5,7全てのバージョンで使用可能ということですね。
中には以下のような複雑なバージョンの書き方をするものもあります。

(PHP 4 >= 4.3.0, PHP 5)

これは、関数が PHP 4.3.0 以降とPHP5のバージョンでのみ利用可能であることを意味します。

Php公式マニュアルでの説明の読み方

preg_match()の説明は以下のようになります。

preg_match ( string $pattern , string $subject [, array &$matches [, int$flags = 0 [, int $offset = 0 ]]] ) : int

まずは最初のstring $patternです。

stringは型の一種です。意味は文字列になります。
PHPでは以下のような型があります。

4 種類のスカラー型

  • boolean:論理値 TUREまたはFALSE
  • integer:整数
  • float, (double も同じ) 浮動小数点数
  • string:文字列

4 種類の複合型

  • array:配列
  • object:オブジェクト
  • callable:コールバックcallbackと同じ
  • iterable:arrayもしくはTraversableインターフェイスを実装したクラスを指す型

その他

  • resource:リソース
  • NULL :ヌル
  • mixed:どの型でもOK
  • number: 整数または小数
  • array|object:array または object のどちらか
  • void:返り値のとき→返り値に意味がない。パラメータにある時→関数がパラメータを受け付けない

[]以下はオプションであることを示します。要するに必要な時だけ使用しましょうということです。

ちなみに&記号をパラメータの前につけるとそのパラメータは参照渡しができることを表します。

参照渡しとは簡単に言うと変数を共有する方法になります。

これで説明は以上になります。
公式リファレンスを読むコツとして例をじっくり見ましょう。パラメータの説明だけでは挙動が分かりません。例を見ることでその関数がどのように動くかが分かると思います。

今回はこれで終わりです。最後まで読んでくださってありがとうございました。

タイトルとURLをコピーしました