(22)
(0)
(0)
(0)
Total: 22 PHP5 配列をメソッドチェインで再帰処理するクラス
CakePHPを使っていると、データ構造が多階層の配列で管理されていることが多く、一括で処理をしたい場合などに度々再帰処理を実装することがあります。
通常であれば、array_map系の関数を使って再帰的に処理を記述することになりますが、
- 毎回array_mapを使うのは面倒だし、もっと簡潔に記述したい
- 個別のグローバル関数・各メソッドを連続して簡単に利用したい
という理由で、以下のように記述できるクラスを作成しました。
（クラスのソースコードは最後に記述しています）
-
// $arrの全ての要素にtrimと半角カナ変換を実施
-
ArrayMap::create($arr)->trim()->mb_convert_kana('KV');
-
-
// $arrの全ての要素に「先頭：」という文字を追加
-
ArrayMap::create($arr)->sprintf('先頭：%s');
※PHP5のマジックメソッドを使って実現していますので、PHP4系では使えません
※通常の手続き型で実装する場合は「array_walk_recursive」「array_map recursive」などで検索するといろいろ参考情報があります。
利用メリット
あくまで個人的な意見ですが、、
- PHPの標準関数をそのまま利用できる
- 自作関数やメソッドを作成する際に再帰処理の考慮が不要になり、単純な処理だけを作成→利用時に合成とすることができる（より再利用できる）
- ソース可読性の向上
利用書式
１．グローバル関数を実行する場合
ArrayMap::create(配列変数)->グローバル関数([引数1],[引数2],・・・)
->次の関数・メソッド
例：配列$arrの全ての要素にtrimと半角カナ変換を実施
-
ArrayMap::create($arr)->trim()->mb_convert_kana('KV');
２．静的クラスメソッドを実行する場合
ArrayMap::create(配列変数)->call(array(静的クラス名,メソッド名),[引数1],[引数2],・・・)
->次の関数・メソッド
例：配列$arrの全ての要素にInflectorクラスのcamelizeメソッドを実施(引数無し)
３．オブジェクトメソッドを実行する場合
ArrayMap::create(配列変数)->call(array(オブジェクト変数,メソッド名),[引数1],[引数2],・・・)
->次の関数・メソッド
例：配列$arrの全ての要素に$thisオブジェクトのconvメソッドを実施(引数1:'a'、引数2:'b')
※呼び出される関数・メソッドは第１引数に処理をする値、第２引数以降に必要であれば引数を設定します。
※ArrayMapクラスから呼び出す際は各要素が自動的に第１引数に設定されるので、第２引数以降を呼び出し時に指定します
※標準関数のstr_replace()やsprintf()などは処理を行う値が最後の引数になっています。
これらはArrayMapクラス内で定義しておけば自動的に最後の引数として設定します。
呼び出し時に動的に最後の引数として要素を渡したい場合は、実行前にp()メソッドを実行する必要があります。
-
ArrayMap::create($arr)->trim()->p()->要素を最後の引数とする関数();
CakePHPでの利用
前半にも記述しましたが、CakePHPでは各データが配列で管理されている為、
以下のような部分で適用できるかと思います。（すいません、未検証です）
- コントローラーのbeforeFilterで入力値($this->dataや$this->params)の変換（trimや改行・文字コード統一など）
- モデルのbeforeValidateなどで値の変換（trimや最大長による切り捨て）
- ビュー内やコントローラーのbeforeRenderなどで値のエスケープ処理
ソースコード
-
<?php
-
#########################################################################
-
/**
-
* 配列要素操作クラス
-
*/
-
#########################################################################
-
class ArrayMap {
-
protected $value;
-
protected $arg_push = false;
-
protected $is_call = false;
-
-
// 値を最後の引数とする関数を追加する
-
-
// コンストラクタ
-
$this->value =& $array;
-
return $this;
-
}
-
// セッター
-
public function set($value) {
-
$this->value = $value;
-
return $this;
-
}
-
public function setByRef(&$value) {
-
$this->value =& $value;
-
return $this;
-
}
-
-
// 値を返す
-
public function v() {
-
return $this->value;
-
}
-
// 次に実行される関数は引数の最後に値を渡す
-
public function p() {
-
$this->arg_push = true;
-
return $this;
-
}
-
// 実行する関数・メソッドをグローバル以外から明示的に指定
-
// 引数を指定する場合は第二引数以降に指定
-
public function call($method){
-
$this->is_call = true;
-
return $this->__call($method, $arguments);
-
}
-
-
// 関数実行メソッド
-
public function __call($method, $arguments){
-
// 自動的に引数位置を変更するメソッド
-
$this->p();
-
}
-
// 値が空の場合
-
return $this;
-
}
-
-
// 値がスカラー値の場合でも動くように
-
$arg = $arguments;
-
if($this->arg_push){
-
$arg[] = $this->value;
-
}else{
-
}
-
$this->arg_push = false;
-
$this->is_call = false;
-
return $this;
-
}
-
-
// 再帰を含めた要素処理
-
foreach($this->value as $k => $v){
-
$arg = $arguments;
-
$arr = new ArrayMap($v);
-
if($this->arg_push) $arr->p();
-
if($this->is_call){
-
}else{
-
}
-
$this->value[$k] = $arr->v();
-
continue;
-
}
-
-
if($this->arg_push){
-
$arg[] = $v;
-
}else{
-
}
-
}
-
$this->arg_push = false;
-
$this->is_call = false;
-
return $this;
-
}
-
-
#########################################################################
-
/**
-
* インスタンス生成用静的メソッド
-
*/
-
#########################################################################
-
return new ArrayMap($array);
-
}
-
}
関連するその他の記事
Comments
One Response to “PHP5 配列をメソッドチェインで再帰処理するクラス”
Leave a Reply
[...] PHP5 配列をメソッドチェインで再帰処理するクラス : エクスギア Blog PHP5 配列をメソッドチェインで再帰処理するクラス : エクスギア Blog [...]