WindowsのPHPでクラスを使うための準備

2017年7月28日カテゴリー : PHP コメント : 0

オブジェクト指向というとJavaを思い浮かべるかもしれませんが、PHPでも使うことができます。今回はWindowsのローカル環境に構築したPHPでオブジェクトプログラミングをするにはどうしたらよいのかを紹介します。

環境

以前に記事にしたこちらのPHP環境を使います。

WindowsのPHPでHello World! | Naokix.net

WordPressを使っている人はローカルにXAMPPが入っていると思うので、その中に入っているPHPフォルダに環境変数のパスを通して流用することができます。

クラスの宣言

PHPでのクラスの書式は次のようになります。

class (クラス名) {
    
}

class (クラス名) {

}

簡単なソースコードを見てみましょう。文字コードはUTF-8、BOMなしです。

<?php

class hoge {
    private $text = "テスト。";
    
    public function test() {
        echo $this->text."\n";
    }
}

$obj = new hoge();
$obj->test();

<?php

class hoge {

private $text = "テスト。";

public function test() {

echo $this->text."\n";

}

$obj = new hoge();

$obj->test();

つい$obj->$test();と書いてしまいそうになりますが、エラーが出るので注意してください。

動作するのか確認します。

クラスを別ファイルに切り離す

ひとつのPHPファイルが長くなってくると、クラスだけを別ファイルに切り離したくなるかもしれません。test.phpとhoge.phpというファイルを作成して同じフォルダに置きます。

まずはhoge.php。

<?php

class hoge {
    private $text = "テスト。";
    
    public function test() {
        echo $this->text."\n";
    }
}

<?php

class hoge {

private $text = "テスト。";

public function test() {

echo $this->text."\n";

}

次にこれを呼び出す側のtest.phpを作成します。

<?php

require_once(dirname(__FILE__) . '/hoge.php');

$obj = new hoge();
$obj->test();

<?php

require_once(dirname(__FILE__) . '/hoge.php');

$obj = new hoge();

$obj->test();

dirname(__FILE__)は実行しているPHPファイルの親フォルダのパスを取得できますが、末尾にスラッシュが付いていません。require_onceの第2引数の頭にスラッシュを付け忘れないでください。

さらに、ファイルが増えてくるとフォルダで分類したくなるかもしれません。testフォルダの中にhoge.phpが入っていると思ってください。

その場合にはtest.phpの3行目を次のように変更します。

<?php

require_once(dirname(__FILE__) . '/test/hoge.php');

$obj = new hoge();
$obj->test();

<?php

require_once(dirname(__FILE__) . '/test/hoge.php');

$obj = new hoge();

$obj->test();

コメントを書きましょう

クラスごとにPHPファイルを作成した場合、ファイルの冒頭やメソッドにコメントを記述することをおすすめします。1ヶ月前に書いたコードは他人が書いたもの同然です。

PHPライブラリを提供するサービスPEARにはAPIドキュメントを自動生成してくれる「PHPDocumentor」というツールがあります。PHPにコメントを記述する場合にはこのツールの書式にならうのが一般的なようなので、どのように書いたらよいのかをまとめておきます。

コメントの基本

PHPにおいてコメントを記述するには、行の最初に次のように記述します。

//(この行はコメントになる)

1	//(この行はコメントになる)

複数行をコメントとして扱いたいのなら、次のように記述してください。

/*
(コメントが閉じられるまですべての行がコメントです)
(この行も)
(この行もコメントになっちゃいます)
*/

(コメントが閉じられるまですべての行がコメントです)

(この行も)

(この行もコメントになっちゃいます)

phpDocumentorの記述ルール

/**からはじめます。行の先頭に*が必要で、これがない行は無視されます。//ではDocCommentにはならないことに注意してください。

/**
 *
 *
 * (コメントを書きます)
 *
 *
 */

/**

* (コメントを書きます)

実際にどのように記述するのか、例を挙げてみます。

ファイルの先頭

DocCommentでは@ではじまる「タグ」を使ってコメントを記述していきます。

<?php
/**
 * ファイルの説明をします。目的などを簡潔に。
 * 詳細な説明は各メソッドに任せましょう。
 *
 * @copyright：Copyright (C) 2017 Naokix.net All Rights Reserved.
 * @license  ：https://opensource.org/licenses/mit-license.html MIT License
 * @author   ：Naokix <naokix03199@yahoo.co.jp>
 * @link     ：(参考にしたURLなど)
 */

<?php

/**

* ファイルの説明をします。目的などを簡潔に。

* 詳細な説明は各メソッドに任せましょう。

* @license ：https://opensource.org/licenses/mit-license.html MIT License

* @author ：Naokix <naokix03199@yahoo.co.jp>

* @link ：(参考にしたURLなど)

@authorで<>に囲まれた部分はメールアドレスと認識されるので、連絡先などを記述しておくとよいでしょう。

クラス

/**
 * クラスの説明をします。
 *
 * 1行空けてもう少し詳しく記述できます。
 * 複数行の記述が可能。省略もできます。
 *
 * @copyright：Copyright (C) 2017 Naokix.net All Rights Reserved.
 * @author   ：Naokix <naokix03199@yahoo.co.jp>
 * @access   ：アクセスレベル
 * @category ：カテゴリー（処理系）
 * @package  ：パッケージ（MVC）
 */

/**

* クラスの説明をします。

* 1行空けてもう少し詳しく記述できます。

* 複数行の記述が可能。省略もできます。

* @author ：Naokix <naokix03199@yahoo.co.jp>

* @access ：アクセスレベル

* @category ：カテゴリー（処理系）

* @package ：パッケージ（MVC）

メソッド

/**
 *  メソッドの説明をします。
 *
 *  1行空けてもう少し詳しく記述できます。
 *  複数行の記述が可能。省略もできます。
 *
 * @param int $id
 * @param string $name
 * @return array|bool
 * @throws (メソッドが発行する例外オブジェクト)
 */

/**

* メソッドの説明をします。

* 1行空けてもう少し詳しく記述できます。

* 複数行の記述が可能。省略もできます。

* @param int $id

* @param string $name

* @return array|bool

* @throws (メソッドが発行する例外オブジェクト)

@paramの書式ですが、