テキストフィールドを CSV として処理する CakePHP ビヘイビア・その１｜加藤正人

DEVELOPERS BLOGデベロッパーズブログ

HOME >
加藤正人のデベロッパーズブログ >
テキストフィールドを CSV として処理する CakePHP ビヘイビア・その１

加藤正人のデベロッパーズブログ

氏名: 加藤正人

役職: 多分ＳＥ

血液型: 秘密

出没: 美味しいもののあるところ

特色: タヒチ大好き。ちょいメタボ。

加藤正人のデベロッパーズブログ

一覧

2020/12/15: CakePHP3 のリダイレクトがうまく行かない例
2020/11/12: Apache Bench
2020/10/05: PhpSpreadsheet でExcel ファイルを読み込む (CakePHP3)

2014/12/13

テキストフィールドを CSV として処理する CakePHP ビヘイビア・その１

たまに1つのレコードに対し、不定個の数値を関係づけなければいけないケースがある。関連付けられるのがレコード構造ではなく単なる数値だけのような場合にわざわざテーブルを定義して外部キーや CakePHP なら hasMany で関連付けるのは大仰だし更新や削除の処理が面倒だ。

そんな場合に、文字列型フィールドが CSV (Comma Separated Values) としてアクセスできると工数を削減できるのではないか、と思いついた。

キーコンセプト:: テキストフィールドを CSV データとしてアクセスする。取得時には配列に展開。保存時には配列を CSV 文字列にして保存。検索式は MySQL の文字列演算で済ます。
実装に際しての制限:: 実装を容易にするため、扱う値 (カンマで区切られる値) は単純な自然数に限定。

利用宣言とパラメータの設計

ビヘイビアとして使用する際にオプションで動作を変更できると可用性が増すだろう。とりあえず次の2つで充分だと思う。

fields: CSVフィールドとして扱うフィールドの名称。ビヘイビアは親モデルが一意に決まるのでモデル名は付けない。必須。
separator: CSV文字列の区切り文字。既定値は ',' (半角カンマ)。

これらを使用して、モデル内で次のように使用を宣言する。(この例では、CakePHP の app/Plugin/LambdaTools/Model/Behavior 配下に SimpleCsvFieldBehavior.php として配置されているものとして記述。)

指定されたオプションは、当該ビヘイビアの setup() コールバックメソッドで解析しプライベート変数 $this->actual_settings[] にオプション名をキーとする連想配列として格納する。

データ取得時の変換

まずは、比較的簡単なデータ取得時の CSV 文字列 ⇒ 配列変換を作ってみる。この機能はビヘイビアの afterFind() コールバックメソッドで実装する。なお、ビヘイビアが使用するオプションはビヘイビアのプライベート変数 $this->actual_settings[] に連想配列として格納されている。

検索結果に CSV フィールドとして指定されたフィールドがあった場合、値の文字列を explode で配列に展開したもので置換するするだけのシンプルな処理だ。

次回は逆にデータ保存時の処理を考えてみる。