[2020/11/30] PHP クラス（class）のオーバーライドの使い方について・その３ (No.235)
[2020/11/28] PHP クラス（class）のオーバーライドの使い方について・その２ (No.234)
[2020/11/25] PHP クラス（class）の使い方について (No.233)
[2020/11/21] PHP PhpSpreadsheet\Chart エクセルシート上に複数のチャートで異なるタイプのグラフ(Bar Chart:棒グラフ等)の色設定について (No.232)
[2020/11/20] PHP Windowsでのバッチ処理における実行結果による制御について（exit()関数とバッチのerrorlevel） (No.231)
-
×
[PR]上記の広告は3ヶ月以上新規記事投稿のないブログに表示されています。新しい記事を書く事で広告が消えます。
-
以下の記事で、クラス（class）のオーバーライドの使い方について説明してきました。
⇒PHP クラス（class）の使い方について
⇒PHP クラス（class）のオーバーライドの使い方について・その２
そこで、今回は簡単なクラスでの説明ではなく、少し有用性があるクラスを作成し、それを元にオーバーライドの使い方について説明します。
以下のクラスは PHPExcel ライブラリを利用して指定されたエクセルファイルをオープンし、全ての行を順次読込むためのクラスです。 メソッドとしては以下の4個を持ちます。- コンストラクタ(__construct):ファイルを指定してインスタンス生成
- ファイルオープン(open):ファイルをオープンして各種属性を取得
- カラムMAX取得(getColMax):カラムの最大値を返す
- 1行データ取得(getLine):データが存在した場合は配列データを返す(最後を超えた場合はfalse)
<?php // Excelライブラリ読込 require_once './PHPExcel-1.8/Classes/PHPExcel.php'; // Excelファイル読込クラス[cExcelGet.php] class cExcelGet { // 共通変数宣言 private $strFilePath; // ファイルフルパス名退避 // エクセル用カラム名 private $arrColName = array( // 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "AA","AB","AC","AD","AE","AF","AG","AH","AI","AJ","AK","AL","AM","AN","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ", "BA","BB","BC","BD","BE","BF","BG","BH","BI","BJ","BK","BL","BM","BN","BO","BP","BQ","BR","BS","BT","BU","BV","BW","BX","BY","BZ", ); // ワークシートオブジェクト取得 private $objWorksheet; private $intLine; // データ行数 private $intColMax; // カラムMAX数 private $intRowMax; // 行MAX数 // コンストラクタ // [引数] $_strFilePath string : ファイルフルパス名 public function __construct ($_strFilePath) { // ファイルフルパス名を退避 $this->strFilePath = $_strFilePath; } // ファイルオープン // [戻り値] :true:正常、false:エラー public function open() { // ファイル存在チェック if (!file_exists($this->strFilePath)) { // ファイル存在エラー return false; } // エクセルファイル読込オブジェクト $objReader = PHPExcel_IOFactory::createReader("Excel2007"); // PHPExcelオブジェクト取得 $objPHPExcel = $objReader->load($this->strFilePath); // ワークシートオブジェクト取得 $this->objWorksheet = $objPHPExcel->getActiveSheet(); // カラムMAX取得 $strColMax = $this->objWorksheet->getHighestColumn(); // カラム文字列 $this->intColMax = PHPExcel_Cell::columnIndexFromString($strColMax); // 行MAX取得 $this->intRowMax = $this->objWorksheet->getHighestRow(); // データ行数 $this->intLine = 0; // 正常 return true; } // カラムMAX取得 public function getColMax() { return $this->intColMax; } // 1行データ取得 // [戻り値] :データが存在した場合は配列データ // （array("A" => "aaa", "B" => "bbbb")の様にカラム文字列でアクセス可能 ） // :false:行最終 public function getLine() { // データ行数 $this->intLine++; if ($this->intLine > $this->intRowMax) { // 処理行数がMAXを超えた場合 return false; } // 1行データ取得・行指定 $arrData = $this->getLineDirect($this->intLine); // データ配列を返す return $arrData; } // 1行データ取得・行指定 // [引数] $_intLine : 行番号(PHPExcelでは行は1～) // [戻り値] :データが存在した場合は配列データ // （array("A" => "aaa", "B" => "bbbb")の様にカラム文字列でアクセス可能 ） // :false:行最終 public function getLineDirect($_intLine) { $arrData = array(); for($c = 0; $c < $this->intColMax; $c++) { //colは [0] 始まりで [0] = "A" となる(rowは [1] 始まり) $arrData[$c] = $this->objWorksheet->getCellByColumnAndRow($c, $_intLine)->getValue(); if (is_null($arrData[$c])) { $arrData[$c] = ""; } else { $arrData[$c] = trim($arrData[$c]); } // 変換後のキーと値で設定 $arrData[$this->arrColName[$c]] = $arrData[$c]; } // データ配列を返す return $arrData; } } ?>
このクラスを使って以下のエクセルを読込んでみます。<?php // クラスファイル読込 require_once 'cExcelGet.php'; // [cExcelGet]クラスの生成 $insXlsx = new cExcelGet("ctest1.xlsx"); // ファイルオープン if ($insXlsx->open() == true) { // 1行データ取得 while ($arrData = $insXlsx->getLine()) { $str = ""; for ($i = 0; $i < $insXlsx->getColMax() ; $i++) { if ($str != "") $str .= ","; $str .= $arrData[$i]; } $str .= "<br>\n"; echo $str; } } else { echo "open error."; } ?>
これを実行するとブラウザに以下の様に表示されます。AAAA,BBBBB,CCC,DD 123,2000,4000,500 ABC001,B001,5000,140 C001,D002,600,200
このクラスを少し改良して、CSVファイルの場合に使用できる様にします。 尚 PHPExcel ライブラリのCSVファイル処理を利用します。（以下の記事を参照して下さい）
⇒PHP PHPExcel CSVファイルの読み込み・書き込みについて
上記の記事から、CSVファイルを読込んで PHPExcelオブジェクト を取得すれば、今回のクラスを親クラスとして利用できることが分かります。
それでは、その前に元のクラスを以下の様に変更します。<?php // Excelライブラリ読込 require_once './PHPExcel-1.8/Classes/PHPExcel.php'; // Excelファイル読込クラス class cExcelGet { // 共通変数宣言 protected $strFilePath; // ファイルフルパス名退避 // エクセル用カラム名 private $arrColName = array( // 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "AA","AB","AC","AD","AE","AF","AG","AH","AI","AJ","AK","AL","AM","AN","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ", "BA","BB","BC","BD","BE","BF","BG","BH","BI","BJ","BK","BL","BM","BN","BO","BP","BQ","BR","BS","BT","BU","BV","BW","BX","BY","BZ", ); // ワークシートオブジェクト取得 protected $objWorksheet; private $intLine; // データ行数 private $intColMax; // カラムMAX数 private $intRowMax; // 行MAX数 // コンストラクタ // [引数] $_strFilePath string : ファイルフルパス名 public function __construct ($_strFilePath) { // ファイルフルパス名を退避 $this->strFilePath = $_strFilePath; } // ファイルオープン // [戻り値] :true:正常、false:エラー public function open() { // ファイル存在チェック if (!file_exists($this->strFilePath)) { // ファイル存在エラー return false; } // エクセルファイル読込、ワークシートオブジェクト取得 $this->openWorksheet(); // カラムMAX取得 $strColMax = $this->objWorksheet->getHighestColumn(); // カラム文字列 $this->intColMax = PHPExcel_Cell::columnIndexFromString($strColMax); // 行MAX取得 $this->intRowMax = $this->objWorksheet->getHighestRow(); // データ行数 $this->intLine = 0; // 正常 return true; } // エクセルファイル読込、ワークシートオブジェクト取得 protected function openWorksheet() { // エクセルファイル読込オブジェクト $objReader = PHPExcel_IOFactory::createReader("Excel2007"); // PHPExcelオブジェクト取得 $objPHPExcel = $objReader->load($this->strFilePath); // ワークシートオブジェクト取得 $this->objWorksheet = $objPHPExcel->getActiveSheet(); } // カラムMAX取得 public function getColMax() { return $this->intColMax; } // 1行データ取得 // [戻り値] :データが存在した場合は配列データ // （array("A" => "aaa", "B" => "bbbb")の様にカラム文字列でアクセス可能 ） // :false:行最終 public function getLine() { // データ行数 $this->intLine++; if ($this->intLine > $this->intRowMax) { // 処理行数がMAXを超えた場合 return false; } // 1行データ取得・行指定 $arrData = $this->getLineDirect($this->intLine); // データ配列を返す return $arrData; } // 1行データ取得・行指定 // [引数] $_intLine : 行番号(PHPExcelでは行は1～) // [戻り値] :データが存在した場合は配列データ // （array("A" => "aaa", "B" => "bbbb")の様にカラム文字列でアクセス可能 ） // :false:行最終 public function getLineDirect($_intLine) { $arrData = array(); for($c = 0; $c < $this->intColMax; $c++) { //colは [0] 始まりで [0] = "A" となる(rowは [1] 始まり) $arrData[$c] = $this->objWorksheet->getCellByColumnAndRow($c, $_intLine)->getValue(); if (is_null($arrData[$c])) { $arrData[$c] = ""; } else { $arrData[$c] = trim($arrData[$c]); } // 変換後のキーと値で設定 $arrData[$this->arrColName[$c]] = $arrData[$c]; } // データ配列を返す return $arrData; } } ?>クラスの中で、子クラスから参照される変数と、子クラスによりオーバーライドされるメソッドを protected として宣言します。 そこで、protected の部分を作成しCSVファイル読込クラスを宣言します。
<?php // CSVファイル読込クラス（エクセル読込クラスから派生） class cCsvGet extends cExcelGet { // コンストラクタ // [引数] $_strFilePath string : ファイルフルパス名 public function __construct ($_strFilePath) { parent::__construct($_strFilePath); } protected function openWorksheet() { // CSV読込クラス生成 $objReader = new PHPExcel_Reader_CSV(); // CSVファイルの文字コード:Shift-JIS $objReader->setInputEncoding('SJIS'); // 区切り記号（カンマ） $objReader->setDelimiter(','); // 文字列の囲み文字（"） $objReader->setEnclosure('"'); // シートの位置 $objReader->setSheetIndex(0); // 読込の結果としてPHPExcelオブジェクトが返る $objPHPExcel = $objReader->load($this->strFilePath); // ワークシートオブジェクト取得 $this->objWorksheet = $objPHPExcel->getActiveSheet(); } } ?>
このクラスを使って以下のCSVファイルを読込んでみます。("ctest1.csv"ファイル)aaaaaaaaaa,bbbbbb,cccccccc,dd 123,456,1000,2000 a01,b01,2000 c02,d03,500,600
以下が読込を実行するソースです。
<?php // クラスファイル読込 require_once 'cExcelGet.php'; require_once 'cCsvGet.php'; // [cCsvGet]クラスの生成 $insCsv = new cCsvGet("ctest1.csv"); // ファイルオープン if ($insCsv->open() == true) { while ($arrData = $insCsv->getLine()) { $str = ""; for ($i = 0; $i < $insCsv->getColMax() ; $i++) { if ($str != "") $str .= ","; $str .= $arrData[$i]; } $str .= "<br>\n"; echo $str; } } else { echo "open error."; } ?>これを実行するとブラウザに以下の様に表示されます。
aaaaaaaaaa,bbbbbb,cccccccc,dd 123,456,1000,2000 a01,b01,2000, c02,d03,500,600
以上、有用性があると言いましたが、特に使い勝手が良くないかもしれませんので、改良して使って頂ければと思います。
PR -
以下の記事で、クラス（class）の使い方について説明しましたが、その時は親クラスのメソッドを、 子クラスで同じメソッド名で宣言することでオーバーライドができることを記しました。
⇒PHP クラス（class）の使い方について
そこで、今回はクラス（class）のオーバーライドの使い方について更に詳しく説明します。
子クラスでオーバーライドしたメソッドですが、親クラスから呼出すことができます。
これは、少し変な感じですが、子クラスでインスタンスを生成し、 そのインスタンスから子クラスのオーバーライド・メソッドを呼出している親クラスのメソッドを呼び出せます。 取敢えず、簡単な例を以下に示します。<?php // 継承の基となる親クラス class cParent { // テスト関数1 public function func1() { echo "cParent_func1<br>\n"; $this->func2(); // 「テスト関数2」実行 } // テスト関数2 public function func2() { echo "cParent_func2<br>\n"; } } // [cParent]から派生した子クラス class cChild extends cParent { // オーバーライド・テスト関数2 public function func2() { echo "cChild_func2<br>\n"; } } // [cParent]クラスの生成 $insParent = new cParent(); // テスト関数1の実行 $insParent->func1(); // [cChild]クラスの生成 $insChild = new cChild(); // テスト関数1の実行 $insChild->func1(); ?>
親クラスに「func1()」「func2()」のメソッドを宣言し、「func1()」の中で自分の「func2()」を呼出しています。 また、親クラスから派生した子クラスに「func2()」というメソッドをオーバーライド宣言しています。
親クラスを生成し「func1()」を実行し、子クラスを生成し「func1()」を実行しています。
これを実行するとブラウザに以下の様に表示されます。cParent_func1 cParent_func2 cParent_func1 cChild_func2
子クラスを生成し「func1()」を実行した場合は、親クラスの「func2()」を実行するのではなく、 子クラスの「func2()」が実行されています。オーバーライドの結果が出ていると思います。
子クラスでオーバーライドすることで、親クラスの元の性質と異なる処理を宣言できます。
異なる子クラスを宣言すれば、親は一緒でも異なる処理を実行するクラスの宣言ができます。以下のソースを見て下さい。
<?php // 継承の基となる親クラス class cParent { // テスト関数1 public function func1() { echo "cParent_func1<br>\n"; $this->func2(); } // テスト関数2 public function func2() { echo "cParent_func2<br>\n"; } } // [cParent]から派生した子クラスその１ class cChild1 extends cParent { // オーバーライド・テスト関数2 public function func2() { echo "cChild1_func2<br>\n"; } } // [cParent]から派生した子クラスその２ class cChild2 extends cParent { // オーバーライド・テスト関数2 public function func2() { echo "cChild2_func2<br>\n"; } } // [cChild1]クラスの生成 $insChild1 = new cChild1(); // テスト関数1の実行 $insChild1->func1(); // [cChild2]クラスの生成 $insChild2 = new cChild2(); // テスト関数1の実行 $insChild2->func1(); ?>これを実行するとブラウザに以下の様に表示されます。
cParent_func1 cChild1_func2 cParent_func1 cChild2_func2
さらに、子クラスの中で、親クラスの処理のも必要な場合は parent:: を使って親クラスのメソッドを呼び出します。<?php // 継承の基となる親クラス class cParent { // テスト関数1 public function func1() { echo "cParent_func1<br>\n"; $this->func2(); } // テスト関数2 public function func2() { echo "cParent_func2<br>\n"; } } // [cParent]から派生した子クラスその１ class cChild1 extends cParent { // オーバーライド・テスト関数2 public function func2() { parent::func2(); echo "cChild1_func2<br>\n"; } } // [cParent]から派生した子クラスその２ class cChild2 extends cParent { // オーバーライド・テスト関数2 public function func2() { parent::func2(); echo "cChild2_func2<br>\n"; } } // [cChild1]クラスの生成 $insChild1 = new cChild1(); // テスト関数1の実行 $insChild1->func1(); // [cChild2]クラスの生成 $insChild2 = new cChild2(); // テスト関数1の実行 $insChild2->func1(); ?>これを実行するとブラウザに以下の様に表示されます。cParent_func1 cParent_func2 cChild1_func2 cParent_func1 cParent_func2 cChild2_func2
-
今回はクラス（class）の使い方について説明します。
クラスと言えば、オブジェクト指向型のデータ処理と言われていますが、 そこまで固く考えなくても、ある処理を行うにあたって必要なデータや関数をまとめたものと言えると思います。
クラスの宣言としては以下の様に行います。（実際の処理では無く日本語で記述しています）class クラス名 { // プロパティの宣言(外部から操作可能) public $変数名[ = 値]; // 内部プロパティの宣言(外部から操作できない) private $変数名[ = 値]; // メソッドの宣言 public function メソッド名(){ メソッド内処理... } // 内部メソッドの宣言 private function メソッド名(){ メソッド内処理... } // コンストラクタ(クラス生成時に呼ばれる関数) function __construct() { クラスの初期処理 } // デストラクタ(クラス破棄時に呼ばれる関数) function __destruct() { クラスの終了処理 } }
プロパティの宣言は public, private でしますが public 宣言されたプロパティは、 クラスの外部からの参照が可能で private 宣言されたプロパティは、クラス内でのみ参照できます。
また、メソッド宣言も同様で public 宣言されたメソッドは、クラスの外部からの呼出しができますが、 private 宣言されたメソッドは、クラス内でのみ呼出しできます。
ここで示した、コンストラクタ及びデストラクタはそれぞれ、クラスのインスタンス生成時及び、破棄時に呼び出される関数で、 必要無ければ宣言する必要はありません。
- 簡単な クラス の宣言例
- クラスの 継承(extends) の使い方の例
- プロパティの アクセス権(public, protected, private) について
- メソッドの アクセス権(public, protected, private) について
- オーバーライド の使い方の例
- コンストラクタ、デストラクタでの オーバーライド の注意点
■簡単なクラス の宣言例
「クラス」宣言とそのクラスを生成し実行する処理を1個のファイルの中で実現しています。 （実際問題としては、クラスの宣言のみを別ファイルにし、それを利用するファイルの先頭で include などで取り込むこともできます。）
以下のソースでは名前用のクラスとして「nameClass」として宣言しています。 プロパティの宣言として「姓名」の「姓」と「名」の部分に分けて退避できる様にし、 「姓名」としてのフル名称を取得するメソッドの宣言を行っています。 （このクラスは特に有用なものではありませんので悪しからず...）
更に、コンストラクタで「姓」と「名」に分けて引数で与える様にしています。 コンストラクタはクラスのインスタンスを生成する場合に new 命令の後にクラス名を記述し、 そのクラス名のカッコの中に引数を記述します。<?php // 名前用のクラス class nameClass { // プロパティの宣言 public $familyName = ""; public $lastName = ""; // メソッドの宣言 public function getFullName(){ return $this->familyName." ".$this->lastName; } // コンストラクタ() function __construct($_familyName, $_lastName) { // クラスの初期処理 $this->familyName = $_familyName; $this->lastName = $_lastName; } } // [nameClass]クラスの生成 $clsName = new nameClass("Tanaka", "Taro"); // フル名のメソッド呼出 $strName = $clsName->getFullName(); // 表示 echo "FullName:".$strName."<br>\n"; // ブラウザ表示 //FullName:Tanaka Taro ?>上記のメソッドの宣言、及びコンストラクタの中で $this が出てきていますが、これは自分自身のオブジェクト（インスタンス）を示すものです。 クラス内の変数やメソッドを参照する場合には $this の後にアロー演算子の -> を用いてアクセスします。
アロー演算子はインスタンスに対するものですので、クラスを生成した後でそのメソッドを呼び出す場合にも用います。
クラスのインスタンスから直接内部の変数がアクセスできるのは嫌な場合は、変数アクセス用のプロパティ設定メソッドを作成し、以下の様にします。 また、クラスのインスタンス生成時に引数の値が指定できない場合も在ると思いますので、コンストラクタの引数に省略できるデフォルト引数値を用いています。// 名前用のクラス class nameClass { // プロパティの宣言 private $familyName; private $lastName; // プロパティ用メソッドの宣言 public function setFamilyName($_familyName){ $this->familyName = $_familyName; } public function setLastName($_lastName){ $this->lastName = $_lastName; } // フル名前を返すメソッドの宣言 public function getFullName(){ return $this->familyName." ".$this->lastName; } // コンストラクタ(デフォルト引数) function __construct($_familyName = "", $_lastName = "") { // クラスの初期処理(メソッドを使ってみました) $this->setFamilyName($_familyName); $this->setLastName($_lastName); } } // [nameClass]クラスの生成 $clsName = new nameClass(); // プロパティ用のメソッド呼出 $clsName->setFamilyName("Tanaka"); $clsName->setLastName("Taro"); // フル名のメソッド呼出 $strName = $clsName->getFullName(); // 表示 echo "FullName:".$strName."<br>\n"; // ブラウザ表示 //FullName:Tanaka Taro■クラスの 継承(extends) の使い方の例
継承 とは基となるクラスの性質を引き継いで、さらに機能を増やしたい場合に使う方法です。
クラスを宣言する時に extends で親クラスを指定します。
以下の例は親クラスとして「cName」を宣言し、それを継承したクラス「cPerson」を宣言しています。
クラス「cPerson」は、クラス「cName」で宣言されたプロパティ、メソッドを全て引き継ぎ、 さらに「cPerson」内で宣言されたプロパティ、メソッドをものを持ちます。
// 継承の基となる親クラス:[cName] class cName { // プロパティの宣言 public $familyName = ""; public $lastName = ""; // メソッドの宣言 public function getFullName(){ return $this->familyName." ".$this->lastName; } } // [cName]から派生した子クラス:[cPerson] class cPerson extends cName { // プロパティの宣言 public $address = ""; // メソッドの宣言 public function getAddress(){ return $this->address; } } // [cPerson]クラスの生成 $insPerson = new cPerson(); // 親クラスのプロパティ設定 $insPerson->familyName = "Tanaka"; $insPerson->lastName = "Taro"; // 子クラスのプロパティ設定 $insPerson->address = "Tokyo"; // フル名のメソッド呼出,表示 echo "FullName:".$insPerson->getFullName()."<br>\n"; // 住所取得のメソッド呼出,表示 echo "Address:".$insPerson->getAddress()."<br>\n"; // ブラウザ表示 //FullName:Tanaka Taro //Address:Tokyo■プロパティの アクセス権(public, protected, private) について
プロパティのアクセス権の指定ですが public, protected, private の種類があります。
PHP の公式の説明によりますと「 public 宣言されたクラスのメンバーには、どこからでもアクセス可能です。 protected 宣言されたメンバーには、 そのクラス自身、そのクラスを継承したクラス、および親クラスからのみアクセスできます。 private 宣言されたメンバーには、そのメンバーを定義したクラスからのみアクセスできます。 」と記されています。
以下に アクセス権(public, protected, private) の例を示します。<?php class cAccess { // プロパティの宣言 public $_pub = "public"."<br>\n"; protected $_pro = "protected"."<br>\n"; private $_pri = "private"."<br>\n"; // メソッドの宣言 public function echoAll(){ echo "public:" .$this->_pub; echo "protected:".$this->_pro; echo "private:" .$this->_pri; } } // [cAccess]クラスの生成 $insAcc = new cAccess(); // プロパティ参照,表示 echo "public:" .$insAcc->_pub; echo "protected:".$insAcc->_pro; // エラーが発生する echo "private:" .$insAcc->_pri; // エラーが発生する // メソッド呼出 $insAcc->echoAll(); ?>これを実行するとブラウザに以下の様にエラーが表示されます。
public:public Fatal error: Cannot access protected property cAccess::$_pro in C:\xampp\htdocs\_test\class4.php on line 21
そこで21行目をコメントにして実行すると以下の様にエラーが表示されます。
public:public Fatal error: Cannot access private property cAccess::$_pri in C:\xampp\htdocs\_test\class4.php on line 22
クラスの外側から protected, private と宣言されたものはアクセスができないので、 さらに22行目をコメント化して再度実行すると以下の様な表示となります。
public:public public:public protected:protected private:private
そこでクラス「cAccess」から派生した「cAccess2」を宣言し、そのメソッドの中で、 「cAccess」の protected 宣言のプロパティがアクセスできることを示します。<?php class cAccess { // プロパティの宣言 public $_pub = "public"."<br>\n"; protected $_pro = "protected"."<br>\n"; private $_pri = "private"."<br>\n"; // メソッドの宣言 public function echoAll(){ echo "echoAll...<br>\n"; echo "public:" .$this->_pub; echo "protected:".$this->_pro; echo "private:" .$this->_pri; } } class cAccess2 extends cAccess { // メソッドの宣言 public function echoAll2(){ echo "echoAll2...<br>\n"; echo "public:" .$this->_pub; echo "protected:".$this->_pro; // アクセス可能 echo "private:" .$this->_pri; // 未定義のNotice警告!! } } // [cAccess2]クラスの生成 $insAcc2 = new cAccess2(); // 親クラスメソッド呼出 $insAcc2->echoAll(); // メソッド呼出 $insAcc2->echoAll2(); ?>これを実行するとブラウザに以下の様に警告が表示されますが protected 宣言のプロパティがアクセスできることが分かります。
echoAll... public:public protected:protected private:private echoAll2... public:public protected:protected Notice: Undefined property: cAccess2::$_pri in C:\xampp\htdocs\_test\class5.php on line 25 private:
■メソッドの アクセス権(public, protected, private) について
クラスメソッドのアクセス権においてもプロパティ同様 public, protected, private の種類があります。 アクセス権を明示せずに宣言したメソッドは public となります。
<?php class cAccess { // publicメソッドの宣言 public function pubFunc(){ echo "public...<br>\n"; } // protectedメソッドの宣言 protected function proFunc(){ echo "protected...<br>\n"; } // privateメソッドの宣言 private function priFunc(){ echo "private...<br>\n"; } function Func(){ $this->pubFunc(); $this->proFunc(); $this->priFunc(); } } // [cAccess]クラスの生成 $insAcc = new cAccess(); // クラスメソッド呼出 $insAcc->pubFunc(); $insAcc->proFunc(); // エラー発生!! $insAcc->priFunc(); // エラー発生!! $insAcc->Func(); ?>これを実行するとブラウザに以下の様にエラーが表示されます。
public... Fatal error: Call to protected method cAccess::proFunc() from context '' in C:\xampp\htdocs\_test\class6.php on line 28
そこで28行目をコメントにして実行すると以下の様にエラーが表示されます。
public... Fatal error: Call to private method cAccess::priFunc() from context '' in C:\xampp\htdocs\_test\class6.php on line 29
クラスの外側から protected, private と宣言されたメソッドはアクセスができないので、 さらに29行目をコメント化して再度実行すると以下の様な表示となります。
クラス内部のメソッドでは全てのメソッドがアクセス可能です。public... public... protected... private...
■オーバーライド(public function) の使い方の例
プロパティ（変数）、メソッド（関数）は同じ名前を子クラスに定義すれば、親クラスのプロパティ（変数）、メソッド（関数）を上書きすることができます。
この上書きができることで子クラスでは、親クラスとは異なる動作をさせることができます。以下にその例を示します。<?php // 継承の基となる親クラス class cName { // プロパティの宣言 public $familyName = ""; public $lastName = ""; // メソッドの宣言 public function getFullName(){ return $this->familyName." ".$this->lastName; } } // [cName]から派生した子クラス class cPerson extends cName { // メソッドの宣言 public function getFullName(){ return "FullName:".$this->familyName." ".$this->lastName; } } // [cPerson]クラスの生成 $insPerson = new cPerson(); // 親クラスのプロパティ設定 $insPerson->familyName = "Tanaka"; $insPerson->lastName = "Taro"; // 子クラスのメソッド呼出,表示 echo $insPerson->getFullName()."<br>\n"; // ブラウザ表示 //FullName:Tanaka Taro ?>子クラスの「getFullName()」メソッドは親クラスのものを上書きしており、メソッドを呼び出すと親クラスのメソッドは呼び出されず 子クラスのメソッドが呼び出されます。
尚、子クラスの「getFullName()」メソッドは親クラスのものを呼出して処理することもできます。
子クラスから親クラスのメソッドを呼び出す場合には parent:: を使います。上記のソースを一部変更します。<?php // 継承の基となる親クラス class cName { // プロパティの宣言 public $familyName = ""; public $lastName = ""; // メソッドの宣言 public function getFullName(){ return $this->familyName." ".$this->lastName; } } // [cName]から派生した子クラス class cPerson extends cName { // メソッドの宣言 public function getFullName(){ return "FullName:".parent::getFullName(); } } // [cPerson]クラスの生成 $insPerson = new cPerson(); // 親クラスのプロパティ設定 $insPerson->familyName = "Tanaka"; $insPerson->lastName = "Taro"; // フル名のメソッド呼出,表示 echo $insPerson->getFullName()."<br>\n"; ?>■コンストラクタ、デストラクタでの オーバーライド の注意点
コンストラクタ、デストラクタもオーバーライドが出来るのですが、少し注意が必要です。取敢えず以下のソースを見て下さい。
親クラスと子クラスを宣言していますが、中身はコンストラクタ、デストラクタの処理のみを行います。
<?php // 継承の基となる親クラス class cParent { // コンストラクタ function __construct() { echo "cParent__construct<br>\n"; } // デストラクタ function __destruct() { echo "cParent__destruct<br>\n"; } } // [cParent]から派生した子クラス class cChild extends cParent { // コンストラクタ function __construct() { echo "cChild__construct<br>\n"; } // デストラクタ function __destruct() { echo "cChild__destruct<br>\n"; } } // [cParent]クラスの生成 $insParent = new cParent(); // [cParent]クラスの廃棄 unset($insParent); // [cChild]クラスの生成 $insChild = new cChild(); // [cChild]クラスの廃棄 unset($insChild); ?>これを実行するとブラウザに以下の様に表示されます。
子クラスの生成時に、子クラスのコンストラクタのみが呼び出され、親クラスのコンストラクタは呼び出されません。
また、子クラスの廃棄時に、子クラスのデストラクタのみが呼び出され、親クラスのデストラクタは呼び出されません。
cParent__construct cParent__destruct cChild__construct cChild__destruct
子クラスは親クラスから派生しているので、当然、親クラスのコンストラクタ、デストラクタを呼出したいことはよくあります。
そこで、子クラスのコンストラクタ、デストラクタの中で、親クラスのコンストラクタ、デストラクタを呼出してやります。以下のソースをを見て下さい。<?php // 継承の基となる親クラス class cParent { // コンストラクタ function __construct() { echo "cParent__construct<br>\n"; } // デストラクタ function __destruct() { echo "cParent__destruct<br>\n"; } } // [cParent]から派生した子クラス class cChild extends cParent { // コンストラクタ function __construct() { parent::__construct(); echo "cChild__construct<br>\n"; } // デストラクタ function __destruct() { parent::__destruct(); echo "cChild__destruct<br>\n"; } } // [cChild]クラスの生成 $insChild = new cChild(); // [cChild]クラスの廃棄 unset($insChild); ?>これを実行するとブラウザに以下の様に表示されます。
cParent__construct cChild__construct cParent__destruct cChild__destruct
-
今回は以下の記事で紹介したチャートに対して、各要素の色を設定する方法について説明します。 基本的にはエクセルで行うのと同じなのですが、系列ラベルの色を変更することで、チャートの各系列の領域の色設定が行えます。
PHP PhpSpreadsheet\Chart エクセルシート上に複数のチャートで異なるタイプのグラフ(Bar Chart:棒グラフ、Line Chart:線グラフ、Area Chart:面グラフ)を作成する方法について
しかし、上記の記事の中の「Line Chart:線グラフ」だけ残念ながら、線の色設定ができませんでした。
そのため、これを除いた3個のチャート「Bar Chart:棒グラフ」「Bar Chart:棒グラフ(積み上げ)」「Area Chart:面グラフ」の塗りつぶしの色設定について記します。
エクセルでは「Line Chart:線グラフ」でも線の色指定はできるのですが、このライブラリではできない様です。（私の調べ方が悪いのかもしれませんが...）
ここで、「系列ラベル」データの生成について説明します。
グラフの「系列ラベル」を PhpSpreadsheet\DataSeries クラスで生成しますが、 PhpSpreadsheet\Chart\DataSeries のクラス生成の引数の中で重要な「ラベル」の配列の要素のクラスである PhpSpreadsheet\Chart\DataSeriesValues のクラス生成の引数は以下の様に定義されています。PhpSpreadsheet\DataSeriesValues __construct( $dataType = self::DATASERIES_TYPE_NUMBER, // データ型の定数 $dataSource = null, // シリーズ(系列)データの位置指定 $formatCode = null, // フォーマットコード $pointCount = 0, // シリーズ(系列)データの個数 $dataValues = array(), // シリーズ(系列)データを直接指定 $marker = null, // ポイントマーカーの指定(文字列) $fillColor = null // 塗りつぶし色設定 )
最後の引数の $fillColor が PhpSpreadsheet\DataSeries クラスにおける色設定となります。
ここに今まで何も設定しなかったのでデフォルトの色がチャートに表示されましたが、 色コードを文字列で設定してやれば、各系列の色が変更できます。
色コードは「FF00AA」の様に16進数の表記で、左の2桁からRGBの指定を行います。
実際のソースは以下の様になります。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Chart\Chart; use PhpOffice\PhpSpreadsheet\Chart\DataSeries; use PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues; use PhpOffice\PhpSpreadsheet\Chart\PlotArea; use PhpOffice\PhpSpreadsheet\Chart\Title; use PhpOffice\PhpSpreadsheet\Chart\Legend; use PhpOffice\PhpSpreadsheet\IOFactory; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト取得 $objWorksheet = $objSpreadsheet->getActiveSheet(); // チャート用テストデータ生成 $objWorksheet->fromArray( array( array('売上', '商品1', '商品2', '商品3'), array( 2016, 12, 18, 15), array( 2017, 15, 19, 10), array( 2018, 21, 23, 20), array( 2019, 18, 14, 12), array( 2020, 20, 21, 23), ) ); // 系列ラベルの指定（色指定） $arrDataSeriesLabels = array( new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING,'Worksheet!$B$1',NULL,1,[],NULL,"ff0000"), //商品1 new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING,'Worksheet!$C$1',NULL,1,[],NULL,"00ff00"), //商品2 new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING,'Worksheet!$D$1',NULL,1,[],NULL,"0000ff"), //商品3 ); // X軸ラベルの指定 $arrCategorysDataSeries = array( new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING, 'Worksheet!$A$2:$A$6', NULL, 5), //2016 to 2020 ); // 描画データの指定 $arrDataSeriesValues = array( new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_NUMBER, 'Worksheet!$B$2:$B$6', NULL, 5), //商品1 new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_NUMBER, 'Worksheet!$C$2:$C$6', NULL, 5), //商品2 new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_NUMBER, 'Worksheet!$D$2:$D$6', NULL, 5), //商品3 ); //===================== // Bar Chart //===================== // チャート・データシリーズの生成 $objSeries1 = new DataSeries( DataSeries::TYPE_BARCHART, // plotType DataSeries::GROUPING_STANDARD, // plotGrouping range(0, count($arrDataSeriesValues) - 1), // plotOrder $arrDataSeriesLabels, // plotLabel $arrCategorysDataSeries, // plotCategory $arrDataSeriesValues // plotValues ); // プロットエリアにチャート・データシリーズに設定 $objPlotArea1 = new PlotArea(NULL, array($objSeries1)); // レジェンド生成（各折れ線の説明を行う） $objLegend1 = new Legend(Legend::POSITION_TOPRIGHT, NULL, false); // チャート・タイトル生成 $objTitle1 = new Title('売上データ:Bar Chart'); // チャート生成 $objChart1 = new Chart( 'chart1', // name $objTitle1, // title $objLegend1, // legend $objPlotArea1, // plotArea TRUE, // plotVisibleOnly 0, // displayBlanksAs NULL, // xAxisLabel NULL // yAxisLabel ); // ワークシート内のチャート位置設定 $objChart1->setTopLeftPosition('A8'); // 左上 $objChart1->setBottomRightPosition('G20'); // 右下 // ワークシートにチャート追加 $objWorksheet->addChart($objChart1); //===================== // Bar Chart:STACKED //===================== // チャート・データシリーズの生成 $objSeries2 = new DataSeries( DataSeries::TYPE_BARCHART, // plotType DataSeries::GROUPING_PERCENT_STACKED, // plotGrouping range(0, count($arrDataSeriesValues) - 1), // plotOrder $arrDataSeriesLabels, // plotLabel $arrCategorysDataSeries, // plotCategory $arrDataSeriesValues // plotValues ); // プロットエリアにチャート・データシリーズに設定 $objPlotArea2 = new PlotArea(NULL, array($objSeries2)); // レジェンド生成（各折れ線の説明を行う） $objLegend2 = new Legend(Legend::POSITION_TOPRIGHT, NULL, false); // チャート・タイトル生成 $objTitle2 = new Title('売上データ:Bar Chart:STACKED'); // チャート生成 $objChart2 = new Chart( 'chart2', // name $objTitle2, // title $objLegend2, // legend $objPlotArea2, // plotArea TRUE, // plotVisibleOnly 0, // displayBlanksAs NULL, // xAxisLabel NULL // yAxisLabel ); // ワークシート内のチャート位置設定 $objChart2->setTopLeftPosition('H8'); // 左上 $objChart2->setBottomRightPosition('N20'); // 右下 // ワークシートにチャート追加 $objWorksheet->addChart($objChart2); /* //===================== // Line Chart //===================== // チャート・データシリーズの生成 $objSeries3 = new DataSeries( DataSeries::TYPE_LINECHART, // plotType DataSeries::GROUPING_STANDARD, // plotGrouping range(0, count($arrDataSeriesValues) - 1), // plotOrder $arrDataSeriesLabels, // plotLabel $arrCategorysDataSeries, // plotCategory $arrDataSeriesValues // plotValues ); // プロットエリアにチャート・データシリーズに設定 $objPlotArea3 = new PlotArea(NULL, array($objSeries3)); // レジェンド生成（各折れ線の説明を行う） $objLegend3 = new Legend(Legend::POSITION_TOPRIGHT, NULL, false); // チャート・タイトル生成 $objTitle3 = new Title('売上データ:Line Chart'); // チャート生成 $objChart3 = new Chart( 'chart3', // name $objTitle3, // title $objLegend3, // legend $objPlotArea3, // plotArea TRUE, // plotVisibleOnly 0, // displayBlanksAs NULL, // xAxisLabel NULL // yAxisLabel ); // ワークシート内のチャート位置設定 $objChart3->setTopLeftPosition('A21'); // 左上 $objChart3->setBottomRightPosition('G33'); // 右下 // ワークシートにチャート追加 $objWorksheet->addChart($objChart3); */ //===================== // Area Chart //===================== // チャート・データシリーズの生成 $objSeries4 = new DataSeries( DataSeries::TYPE_AREACHART, // plotType DataSeries::GROUPING_PERCENT_STACKED, // plotGrouping range(0, count($arrDataSeriesValues) - 1), // plotOrder $arrDataSeriesLabels, // plotLabel $arrCategorysDataSeries, // plotCategory $arrDataSeriesValues // plotValues ); // プロットエリアにチャート・データシリーズに設定 $objPlotArea4 = new PlotArea(NULL, array($objSeries4)); // レジェンド生成（各折れ線の説明を行う） $objLegend4 = new Legend(Legend::POSITION_TOPRIGHT, NULL, false); // チャート・タイトル生成 $objTitle4 = new Title('売上データ:Area Chart'); // チャート生成 $objChart4 = new Chart( 'chart4', // name $objTitle4, // title $objLegend4, // legend $objPlotArea4, // plotArea TRUE, // plotVisibleOnly 0, // displayBlanksAs NULL, // xAxisLabel NULL // yAxisLabel ); // ワークシート内のチャート位置設定 $objChart4->setTopLeftPosition('H21'); // 左上 $objChart4->setBottomRightPosition('N33'); // 右下 // ワークシートにチャート追加 $objWorksheet->addChart($objChart4); // [test-g-5-1.xlsx]:Excel2007形式で保存する $objWriter = IOFactory::createWriter($objSpreadsheet, 'Xlsx'); $objWriter->setIncludeCharts(TRUE); $objWriter->save('test-g-5-1c.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
以前の色指定が無い場合は、以下の様にデフォルトの色が設定されています。
-
今回はPHPのプログラムをWindowsでのバッチ処理で実行する時の、実行結果による制御について説明します。
通常、PHPのプログラムを途中終了させるには exit() 関数を用います。この関数ですが、PHPの公式サイトによれば以下の様に定義されています。// exitの引数が文字列の場合 exit ([ string $status ] ) : void // exitの引数が数値の場合 exit ( int $status ) : void
【PHP公式マニュアルより】 status が文字列の場合は、この関数は終了直前に status を表示します。 status が int の場合は その値が終了ステータスとして使われ、表示はされません。 終了ステータスは 0 から 254 までの値でなければなりません。 終了ステータス 255 は PHP に予約されており、使用してはいけません。 ステータス 0 は、 プログラムを正常終了させる際に使用します。
普通、終了させる場合には exit() と引数が無い状態で使いますが exit(0) とか exit(1) とすることで、 PHPプログラムの終了ステータスを呼出し元に返せる様です。■exit() の使用例
コマンドプロンプトでのプログラムの実行を想定し引数が指定されていれば正常とし、未指定であればエラーとするプログラムを以下に示します。 $argv 変数のインデックス「1」が宣言されていれば正常を表示し exit(0) を行い、未宣言であればエラーを表示し exit(1) を行います。
<?php // ソースファイル[exit1.php] if (isset($argv[1]) == true) { // 引数$argv[1]が指定された場合、正常終了 echo mb_convert_encoding("正常終了", "SJIS", "UTF-8"); exit(0); } else { // 引数$argv[1]が未指定の場合、エラー終了 echo mb_convert_encoding("エラー終了", "SJIS", "UTF-8"); exit(1); } ?>
私の環境ではWindowsの xampp でPHPを導入し、DOSのコマンドプロンプトからの実行を行っています。 始めの実行は引数無しで行い、「エラー終了」が表示されます。その後、引数を指定した実行で「正常終了」が表示されます。
C:\>C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit1.php エラー終了 C:\>C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit1.php 111 正常終了 C:\>
このままでは exit() で返される値が分からないので、バッチファイルでプログラムを起動する様にします。
■バッチ での使用例
それでは上記のプログラムを表示部分を省いて終了コードのみを返す様にします。（ファイル名を「exit2.php」に変更）
<?php // ソースファイル[exit2.php] if (isset($argv[1]) == true) { // 引数$argv[1]が指定された場合、正常終了 exit(0); } else { // 引数$argv[1]が未指定の場合、エラー終了 exit(1); } ?>これをバッチで実行するファイルを以下に示します。（ファイル名を「exit1.bat」とする）
C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit2.php 111 @echo off if %errorlevel% == 0 ( echo "正常" ) else ( echo "エラー" ) @echo on C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit2.php @echo off if %errorlevel% == 0 ( echo "正常" ) else ( echo "エラー" )
バッチでは errorlevel 変数にプログラムの終了コードが返されますので、その値を判定し処理を制御します。
バッチファイルの実行は以下の様になります。（フォルダを「C:\xampp\htdocs\_test」に移動して実行）C:\xampp\htdocs\_test>exit1.bat C:\xampp\htdocs\_test>C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit2.php 111 "正常" C:\xampp\htdocs\_test>C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit2.php "エラー" C:\xampp\htdocs\_test>
PHPプログラムの中でいろんなレベルの異常終了が在ると思いますので、それぞれの終了コードを決めてバッチ側で各種の処理を行うことが可能になります。
■バッチ に関連してプログラムの CLI 及び ブラウザ 実行について
上記まではPHPスクリプトのコマンドラインでの実行、つまり CLI での実行を行いました。 （CLI とは Command Line Interface 略称なのでコマンドライン実行のことなのですが）
プログラムが CLI からの実行なのかそれとも ブラウザ からの実行なのかで処理を分けたい場合があると思います。
そのためどこからの呼出なのかを判定できる関数として php_sapi_name() があります。
php_sapi_name() はウェブサーバーと PHP の間のインターフェイスの型を返します。
（"apache", "apache2handler", "cgi-fcgi", "cli", "cli-server" ,...）
そこで何かの表示を行う場合、この関数の返す値により、コマンドライン実行であれば表示文字列を「Shift-JIS」変換し、そうでなければそのまま出力する様にします。<?php // ソースファイル[exit3.php] (ソースの文字コードは「UTF-8」で登録) $str = "出力する文字列例です。"."\n"; if (php_sapi_name() == "cli") { // コマンドライン実行の場合 Shift-JIS変換 $str mb_convert_encoding($str, "SJIS", "UTF-8"); } echo $str; ?>これをコマンドライン実行すると以下の様になります。
C:\xampp\htdocs\_test>C:\xampp\php\php.exe C:\xampp\htdocs\_test\exit3.php 出力する文字列例です。 C:\xampp\htdocs\_test>
尚、ブラウザで実行させても以下の表示になります。
出力する文字列例です。