第三生菓子味見帳

CakePHP 3 の日本語情報が少ないので充実するまでのつなぎにと開始。なんだかんだで CakePHP 以外も無差別に。 Since Jan. 2015

[ajimicho-blog]

TypeScript 文句一個垂れます

このコードをコンパイル。

namespace a.b.c { import f1 = e.f; import f2 = b.e.f; import f3 = a.b.e.f; function d() { return f1 + f2 + f3; } } namespace a.b.e { export var f; }

どうなるかというと、

var a; (function (a) { var b; (function (b) { var c; (function (c) { var f1 = b.e.f; var f2 = b.e.f; var f3 = a.b.e.f; function d() { return f1 + f2 + f3; } })(c = b.c || (b.c = {})); })(b = a.b || (a.b = {})); })(a || (a = {})); var a; (function (a) { var b; (function (b) { var e; (function (e) { })(e = b.e || (b.e = {})); })(b = a.b || (a.b = {})); })(a || (a = {}));

はいちゅーもーく。 f1、f2、f3 という名前で import されている３つの f は全く同じものを指してるんだけどさ。 もちろんそのことはコンパイラーもご存知のはず。

なのになんでコンパイル結果に a. が付いたり付かなかったりしてるんじゃい！

e.f とだけ書いたら前に b. を補ってくれるのはありがとうございます。この御恩は一生忘れません（記憶の限り）。 ただ逆に必要ないところまで書いた時に削って欲しき。

というのも、愛用 IDE であらせられる PhpStorm 様が、フルで書かないとエディター上で参照を解決できないことがある。（Ctrl + クリックでジャンプしたり、f1. って書くとサジェストしてくれたり、が効かない） そこはそこで PhpStorm 様がアホであらせられる問題でもあるんだけど、解決するためにフルで書くと出力結果が長くなる！ あ、念のため言っておくと PhpStorm 様は基本的にめっちゃ優秀です。

ちなみに VSCode だと案外参照解決してくれる模様。

その後また UglifyJS でコードを圧縮したりもするんだけど、流石に圧縮ツールごときが f1 と f2 と f3 が同一であることまで解釈してくれようはずもなく、そこは TypeScript コンパイラーが頑張っていただかないといけないところかと存じた夏 2016。

大規模なシステムになると無視できないよ？

（書いてから思ったけど使ってるコンパイラーは現在の最新版では無いんだよね。今はどうなんだろう。）

[ajimicho-blog]

VS Code アップデートエラー

Visual Studio Code のアップデートをしようとしたら。謎エラー。

The setup files are corrupted. please obtain a new copy of the program.

面倒で放置していたんだけど、重い腰を上げていっちょ解決してみようかと思ったらネットにいい情報がすぐに見つからなくて、結局自力で解決したので、困ってる人もいるんじゃないかということで、情報流しておく。

Code のアップデート。 使っている間にインストーラーをネットから落としてきてインストールという、まぁよくある形式のようで。

ところが、ダウンロードしたファイルが破損していた場合、落ちる。 でもダウンロードは完了しているつもりになっているので、何回やってもインストールの準備は完了してますぜ旦那とドヤ顔で言ってくる。 ハッシュ値くらい見ろよ！バカMS！

結論を言うと、壊れたインストーラーを窓から勢い良く投げ捨てれば、新しくダウンロードしなおしてくれる。 あ、 Windows 上から削除することを比喩したようで上手いですね。

ね。

以下手順

エラーダイアログが出ている時に、おもむろに Windows タスク マネージャー を開きます。

Ctrl + Shift + Esc などでよろしく。

“アプリケーション” タブから該当のダイアログのタスクを見つけ、右クリック → プロセスの表示(G)

"プロセス" タブでハイライトされたアプリケーションファイルを右クリック → ファイルの場所を開く(O)

そいつだ。犯人はそいつだ。消せ

自分でやった時はフォルダごと消したけど、まぁ多分ファイルで大丈夫でしょ。知らんけど！以上！

[ajimicho-blog]

Chrome for Android で HTMLのダウンロード

ちょっと入用のために、Android から HTML を気軽にダウンロードできるブックマークレットを作ってみた。

あくまで HTML しかダウンロードしないよ！ 埋め込まれた画像とか、外部リソース (CSS ファイル、JS ファイルとか) は一切なし。

ブックマークレットの導入方法なんかは説明され尽くしているのでどこかで調べてほしいんだけど、作ったブックマークレットをご自由にお使いくださいってことでここにおいておくことにする。

そうだなぁ、じゃあライセンスは、 WTFPL ってことで。

まず、以下のブックマークレットをページ上で実行する。

javascript:addEventListener("click",function(){open("view-source:"+location.href);removeEventListener("click", arguments.callee)})

実行したら、画面のどこかをタップ。出来ればリンクなんかが張られていない安全な場所をタップね。

これは現在のURLの先頭に ”view-source:” を付与して新しいウィンドウで開くだけのブックマークレット。たいした作業じゃないけど、ハイフンとかコロンとか、スマホだと結構入力するのが億劫だったりするので作ってみた。

実はデスクトップ版 Chrome で「ページのソースを表示」を実行したときにおなじみの "view-source:http://xxxx" だけど、Android 版でもアドレスを指定して開けばしっかり表示される。

実行した後に一回タップしなきゃいけないのはポップアップブロック対策ね。だって勝手に開くとブロックされちゃうんだもん。(普段は感謝しているけど、たまにうざいね！) ユーザー操作によって開きましたよっていう免罪符が必要だから、面倒なワンクッションがあるけど許して。

次に、以下のブックマークレットを実行。

javascript:!function(s,a,e,d,l,i){d=document;a=d.createElement('a');l=d.getElementsByTagName("tr");for(i=0;e=l[i];i++)s.push(e.innerText);a.download=d.title||decodeURIComponent(location.href.match(/[^\/]*$/))||"webpage";a.href='data:application/octet-stream,'+encodeURIComponent(s.join("\n"));a.click()}([])

これでダウンロードが実行される。 本当は1個のブックマークレットでダウンロードの実行まで行きたかったんだけど、Same origin policy っていうやつに抵触して実行できなかった。 ポップアップ先のURLが別のサイトだと、ウィンドウ同士で通信できないって言う制約がある。view-source: から始まるものは同じ URL とはみなさないみたい。

ちなみに Android 版の Chrome でブックマークレットを実行する場合、ブックマーク画面を開いてから実行しちゃだめ。 これは元の画面ではなくて、ブックマーク画面に対して実行されてしまうため。 分かりやすいブックマーク名をつけて、アドレス欄からサジェスチョンで実行しよう。

このブックマークレットっていうのは古い技術で、最近のブラウザはアドオンだの拡張機能だので強化し放題だからしばらく注目されていなかったんだけど、拡張機能のないスマホブラウザにとっては希望の光ってことでここ数年で再注目されているような気がする。

もっとも、Firefox を筆頭に拡張機能のあるスマホブラウザもあるようだけど。

[ajimicho-blog]

JS の bind の polyfill 改良版

また bind の話ですか。

JavaScript の Function.prototype.bind() の polyfill が MDN で紹介されている。

この bind って機能は比較的初期の段階で各ブラウザに実装されてるし、polyfill (実装されていない場合の代替手段みたいなの) が必要なことは少ないんだけど、問題は Android のやつ。

あいつ、一部の古い機種で bind ができない。 驚愕したね。マジかよ、bind ってもっと超標準みたいな扱いかと思ってたよ！

そこで polyfill の出番なんだけど、上に張ったリンク先の polyfill はリンク先にも書かれているように、本物とは幾つか違いがあるらしい。

その違いが問題になりそうな場面に出くわしたので、思いつく限りで修正を加えてみた。

まずはコード！

if (!Function.prototype.bind) { (Object.defineProperty ? function(target, name, value) { Object.defineProperty(target, name, { value: value, }); } : function(target, name, value) { target[name] = value; })(Function.prototype, "bind", function(b) { if (typeof this !== "function") { // closest thing possible to the ECMAScript 5 // internal IsCallable function throw new TypeError("Function.prototype.bind - what is trying to be bound is not callable"); } var fArg = []; for (var i = 0; i < this.length - arguments.length + 1; i++) { fArg.push("_" + i); } var a = this, c = Array.prototype.slice, d = arguments; var fBound = eval("(function(" + fArg + "){return a.apply(typeof a.prototype=='object'&&this instanceof a?this:b,c.call(d,1).concat(c.call(arguments)))})"); fBound.prototype = this.prototype; return fBound; }); }

改善点について。

サンプルコードが動作しない

まず、 MDN の実装では、 MDN に載っている bind の使用例が動かない。 これはいかんでしょ。

問題があるのは「束縛された関数をコンストラクタとして使う」の項で挙げられているコード。

doesn't support in the above polyfill works fine with native bind

(拙訳) 下記の polyfill では非対応 本物の bind ならきちんと動きます

とコメントされている通り、うまく動いていないようだ。

上記の改良版ならおそらく本物と同じように使えるはず。 ちなみに問題のコードの最後の行、

new Point(17, 42) instanceof YAxisPoint; // false

と書いてあるけど、これは true が正しい。 false になるのが正しいんだと思って頑張ってたけど、本物の bind は true になることに気がついて、この部分の英語版 MDN を参照したらコメントが true に直ってた。 日本語版のコード (コメント) が間違ってるのか！ 騙された！

もうひとつ問題があるのは、「ショートカットを作成する」の項。

組込み関数 (該当コードでは Function.prototype.call) に対して bind を使用すると、MDN の polyfill はエラーで落ちる。 どうやら組込み関数は通常の関数オブジェクトと違い、prototype プロパティが未定義らしい。 そして prototype が未定義 (undefined) 等の非 object 型の値の関数オブジェクトを MDN の polyfill で束縛すると、束縛後の関数実行時に落ちる。 この問題も修正した。

ただしこの2つを組み合わせると上手くいかない。いや、この使い方は流石にないと思うけど。 「prototype が非 object 型の関数オブジェクトを束縛したものに対して new でオブジェクトを作る」ケースね。

var Constructor = function(arg) { // 関数オブジェクト (コンストラクター) を作成 this.a = arg; }; Constructor.prototype = undefined; // prototype 消してみる var Bound = Constructor.bind(0, "Hi!"); // 第1引数 を "Hi!" に束縛する new Bound(); // 本物では {a: "Hi!"}、polyfill (改良版含む) では {} a; // 本物では undefined、polyfill (改良版含む) では "Hi!"

引数の数

MDN で本物と polyfill の相違点として4つめに挙げられている。 bind された関数の length、つまり引数の数が本物と違って常に0になるってとこ。

eval で解決。汚いぜ。 最初は Function コンストラクタで解決したんだけど、そうすると 束縛後の関数に余計なプロパティを追加せざるを得なくて、余計汚い気がしたのでボツ。

(function(a){}).bind({}).length // 本物と改良版 polyfill では1、MDN の polyfill では0

ちなみに束縛前の元関数の length と等しいわけではない。引数を束縛したら、束縛後の関数からは束縛した引数の数が差し引かれる。

(function(a, b, c){/*引数が3つの関数*/}).bind({}, 1, 2).length // 引数を2つ束縛したので最終的な引数は1つ

bind プロパティが enumerable

bind が存在しない環境で Function.prototype に bind を普通に追加したら、あらゆる関数オブジェクトに列挙可能な "bind" が定義されちゃう。 関数を for...in ループさせることは稀かもしれないけど、ディープコピーみたいなことをやろうとしたら関数を他の値と区別せずにループするかも。 ってなると、"bind" という値がループ対象になる。でもその bind もまた関数なので、更に "bind" を持ってる。再帰処理の無限ループってわけですね。 (今回改良版を作ったきっかけはそれと似たようなこと)

ということで、"なるべく" 列挙不可のプロパティとして定義するように修正。 列挙不可のプロパティとして定義するには Object.defineProperty() が必須なんだけど、それすらなかったらもうしょうがないから列挙可能で妥協するようにした。 そもそも関数を for...in ループさせないプログラムで利用する限りはここはどっちでもいいところなわけで。 例えば for...in に突っこんじゃうまえに、if(typeof ループ対象 != "function") とかそんなんで回避できるし。

最後に

eval 使ってるから js ファイルの圧縮難読化ツールを使用する場合は注意。 難読化ツールは詳しくないけど、変数名変えちゃったりすることもあるんでしょ？ eval に渡しているコード文字列の中で参照しようとしている変数名 (a ～ c) は変えられちゃまずい。 圧縮ツール [email protected] (Koala についてきた) で試した限りは、そこは気を使ってくれているようでなんともなかったけど、駄目にしちゃうツールもあるかもしれない。

[ajimicho-blog]

PHP 文字列中の定数の展開っぽいことを実現する

PHPで、変数展開ってあると思うんだけど、あいつは便利で僕も結構使う。

$a = 'world'; echo "Hello, $a";// => 'Hello, ' . $a と同様の出力を得られる

でも定数展開はできない！ なぜなら、PHPは "ダブルクオーテーション" の中に $Doller記号 を見つけたら、そこを変数名として扱う。 定数は$を使用しないので展開してもらいようがない。

でも定数を展開したいっていう人は世に多く、ggると色々なやり方がバッドノウハウですと出回っている。 今日はそんな人たちの間に参加してみようと思う！

とりあえずコード

まずは以下のようなクラスと関数を宣言する。

<?php class ConstantAccessor implements ArrayAccess { public function offsetExists ( $offset ) {} public function offsetGet ( $offset ) { return constant($offset); } public function offsetSet ( $offset , $value ) {} public function offsetUnset ( $offset ) {} private function __construct() {} public static function getInstance() { static $instance; $instance = $instance ?: new self(); return $instance; } } function registerConstantPrefix(&$prefix) { $prefix = \ConstantAccessor::getInstance(); }

次にとりあえず先立って定数がないと始まらないよね。

<?php define('FOO', 1); define('BAR', 2);

最後に使い方。

<?php registerConstantPrefix($_);// $_ という変数を定数展開の合図に使用することを宣言する。 echo "FOO: $_[FOO], BAR: $_[BAR]$_[PHP_EOL]"; // 出力テスト

これで、 FOO: 1, BAR: 2\r\n という出力が得られるはず。

解説

ArrayAccessです。それが全てです。

変数展開ってのは、 $変数名 のあとに1つだけ [index] をつけて、配列変数の内部の値を参照できる。 (2つ以上付けたい場合は {$xx[a][b]} のように {ブラケット} で囲みましょう。)

つまり、1次元配列のメンバーであれば、変数展開として比較的手軽に中身を参照できる。

一方、ArrayAccessっていうインターフェースは、実装されたクラスのインスタンスを配列であるかのように扱える。 つまり、 $_ という変数に入っているのがArrayAccessなオブジェクトだとしたら、それは配列でもないくせに、

$_['A'] = 'aaa';

みたいなことをしていい。 でも、配列じゃないんだからそんなことされてもどうしたらいいのか困る。 困るから、どうしたらいいかプログラマーが決めてくれ、っていう仕組み。

具体的には offsetExists, offsetGet, offsetSet, offsetUnset と4つのメソッドをクラスに作って、それぞれの中でどうしたいのか決めろということ。

そのうち offsetGet が、配列として値を取り出そうとしたらどうするんだいメソッド。 取り出そうとした配列のキーが引数で入ってくる。

つまり、 $_['FOO'] は $_->offsetGet('FOO') と同じ。 さらに、変数展開を使用する場合は 'シングルクオート' は書かないことになっているので、"$_[FOO]"となる。 じゃあ更に、offsetGetの中で受け取った 'FOO' を使って、 const('FOO') に変換してやる。 const('FOO')は FOO (定数FOOの参照)と同じ。

まとめると、

とみなされる。

考え方としてはそんなところ。 すごく邪道な感じがするね。どうしても簡単に定数展開したいなら、使ってみるといいかも。 多分、これくらいの文字数で実現するのが最も最短文字数だと思う。

でもね、1つだけ頭に入れておいてほしい。

echo "FOO: $_[FOO], BAR: $_[BAR]$_[PHP_EOL]";// 定数展開ワザを使用した場合 echo 'FOO: '.FOO.', BAR: '.BAR.PHP_EOL;// 普通に書いた場合

おやおやー？(´・ω・`)

おまけ。クラスの解説。使い方とは関係ないので興味あればどーぞ。

まず今回、オブジェクトを生成しないと実現できないけど、プロパティもないので何度も使うなら使い回したい。 でもインスタンスを変数に入れておいても関数スコープに入っちゃうと global か use 宣言しないと使えない。 てことでシングルトン設計にしてみたけど、毎回 ConstantAccessor::getInstance() を呼ぶかっていうと面倒だし、名前空間を使用するとそれだけのためにConstantAccessorの位置を指定しなきゃいけなかったりする。 なので registerConstantPrefix() を定義してどこからでもインスタンスを取りにいけるようにしてみた。 受け取った変数にインスタンスをぶち込むだけのグローバル関数。 (PHP の &リファレンス渡し とは、変数の別名として扱うことなので、=代入 すらも元の変数に反映される。)

[ajimicho-blog]

JSのbindで作られたFunctionのcalleeはbind前のFunction？

↑何言ってんだこいつ。 待って待って。聞いて。

今回はPHPどころかJavaScriptのお話。

JavaScriptにFunction.prototype.bind()ってあるじゃない。 thisを変更するあれ。

あと、arguments.calleeってあるじゃない。 関数から見た自分自身がわかるあれ。

その2つを組み合わせた時の奇妙な動きが気になって朝も起きれないので紹介します。

// 自分自身を返す超絶役立たず関数 var fn = function(){ return arguments.callee; } fn == fn            // 1. もちろんtrue fn == fn()          // 2. もちろんtrue fn == fn.bind({})   // 3. これはfalseになります。別の関数オブジェクトを作るので。 fn == fn.bind({})() // 4. trueだと…？

3でわかるように、bindによって作られた関数オブジェクトは、オリジナルの関数オブジェクトとは別物です。 ところが、bindによって作られた関数内でarguments.calleeを参照すると、オリジナルの方が参照されてしまいます。

なんでこれ。これなんで。 教えて誰か。誰か教えて。

150429 追記

MDN に関係ありそうな説明。

“この新たな関数の本体（ECMAScript 5 の観点では内部の call プロパティ）は、call() 先の関数（束縛された関数のターゲット関数）【訳注: fun.bind(thisArg) の fun 】 と同じです。”

— https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Function/bind

この部分、そういう意味で言ってるのかな。

[ajimicho-blog]

従来のエディターでは敵うハズのない特徴。テキストエディター「Caret」

どんな環境でもまず絶対使うってソフト、テキストエディターが挙げられる気がするんだけど、技術寄りの人ならかなりの頻度で使うよね。

そしてこだわるよね。

僕はサクラエディタ派だけど、最近はCaretというChromeアプリに浮気中。

というのも、基本性能はサクラエディタに匹敵する上、いくつかの点でサクラエディタを上回っていると思う。

いくつか特徴を紹介。サクラエディタを愛用してきたもので、サクラエディタとの比較っぽくなっちゃうけど。

かっこいい

重要だよね。やっぱかっこいいエディターでモチベーション上げていきたいじゃない！

ご覧ください。用意されているテーマの中でワタクシが気に入った配色でございます。

サクラエディタはアプリケーション全体の雰囲気までは変えられないですからねー。 (トゲのある言い方)

シンタックスハイライトどころか、シンタックスチェック

キーワードを見つけて色を変えるハイライト機能があるけど、Caretはもっとやってくれちゃう。

なんと、文法的にチェックして、間違えを教えてくれる。 以下、ネストしまくりの糞コード書いたらカッコの数わかんなくなっちゃったテヘペロあれなんだこのバツマークおおおマウスオーバーでなんか出たの図。

ついでにショートカットキーでのコメント切り替えとかも出来ちゃうようです。 ソースコードとして認識して言語に応じたコメント形式を判別できるっぽい。 例えば1つのPHPファイルでも、その部分がPHPのコードなのか、HTMLなのか、埋め込まれたJavaScriptなのか、またはCSSなのかでToggle Commentコマンドの挙動が変わってる。便利コレ！

設定ファイルを持ちださなくても勝手に同期

クラウドです。クラウドの強みですよ奥さん。 テーマカラーを変えた？ しかも自分でこだわりぬいた究極のテーマを自作した？ OK、じゃあこの別のマシンからCaretを開いてみなさい。 そこに表示されたのが、君の言った自作テーマだね？ (誰)

もう1つクラウドの強みを上げるなら、アップデートが自動なのも便利。 もしこれから新機能が追加されるなら、それはいつの間にか使えるようになるはず。

ただし設定画面がないのが少し残念。ほぼデフォルト設定で不便はないと思うけど、変えたい場合は設定ファイルを直に編集することに。 といってもJSON(*みたいな)ファイルだし、英語だけど書き方はコメントされていて難解というほどではないかな。(*正式なJSONはコメントがないらしい。) 全部把握し切れてないけど、どうやらすべての機能のショートカットキーとプルダウンメニュー内での表示位置をカスタマイズ可能なようで。

プラットフォームを問わない

Win / Mac / Linuxなど、プラットフォームを問わないというウェブアプリの長所も。

早速Linuxディストリビューションの1つであるUbuntuにインストール。 実は上の写真はUbuntu上のもの。 ファイル関連付けには少々コツが入りますが、普段使い用テキストエディターとしてgeditの立場を奪わせてみました。

プロジェクト単位のファイル管理

プロジェクトのルートフォルダを登録すると、左ペインが出現。

ここからファイルを選択すると、すぐにそのファイルの編集に入れる。 ディレクトリが近くて、ただし完全に一致しない幾つものファイル群を編集する場合はいちいちファイル選択ダイアログを開かなくてよく便利。

あと、GoToという機能は、文字を入力すると即座にプロジェクト内をリアルタイム検索してファイルを開く機能のようです。 指定した文字がファイル名に一致するファイルがまずリストされて、本文中にヒットするファイルもその下に表示されているということかな。

え、これIDEじゃないの？ (さすがにコンパイラやデバッガはない模様)

その他リッチなテキスト編集機能

雑なくくりで。 正規表現検索 / 置換、矩形選択、マクロ、行ソート、大 / 小文字変換など、そこそこの機能を持ったテキストエディターなら常識の機能はだいたい網羅しているかと。

ただしですよ。サクラエディタに敵わない機能がここに隠れています。

それは、正規表現の置換文字列に、改行コードが入れられないということ。 つまり、ある文字列を改行に変換することができないということ。 個人的に結構でかい。

やり方が悪いのかな。\r\nとか\nとか\Rとか試してみた感じ、そのまま出力されちゃう。

今のところそれ以外の点では非常に優秀だと思う。

特に設定の同期、自動アップデート、マルチプラットフォームは、従来のテキストエディターにはほとんどないのでは？ テキストエディターというとあまり大規模なソフトウェアではないはずなので、クラウドとかマルチプラットフォームとか、そこまでするっていう例はほとんど無いんじゃないかな。

その点クラウドアプリ、ウェブアプリっていうだけで当たり前のように全部実現されちゃうのは、次世代感を感じさせる。

[ajimicho-blog]

言い訳

CakePHP3安定版もリリースされてしばらく経ったけど、実はちょっとCakePHPを使った作業から離れてるという感じです。こんにちは。

安定版じゃないからバグってるよーとか書いたけど安定版で直っているかも確認できていません。誰か教えて！

気が向いたらCakePHP以外の技術系の記事を書くかもしれません。今日早速もう一個書きたいと思います。

更に気が向いたら、最終的には分けるかも。ブログを分けるか、カテゴリを分けてCakeじゃないブログに。

っていう、この投稿は何だったのかというとタイトルが全て。

[ajimicho-blog]

CakePHPのアソシエーション設定時、'foreignKey' => falseが正しく処理されない

CakePHP 3.0.0 RC-1で起こっている。まぁ、安定版じゃないもんねぇ。

たぶん、一緒にconditionsを指定して独自の条件でアソシエーションを定義したいとき、勝手に外部キーを使われると邪魔くさいのでオフにしたい場合に使うことが多いだろう。

生成されたSQLを見る限り、where条件で`カラム名` = (ここに何も入らない)となってシンタックスエラー。勝手に生成されたSQLがシンタックス面で怒られてしまうというのはやっぱりフレームワークのバグなんだと思う。

'foreignKey'=>falseは安定版リリース後に使うとして、暫定対応としてはエンティティーにゲッターを定義することだろうか。

必要最低限の修正にするため、エラーの起こらないカラム名をforeignKeyに指定しておく。アソシエーション自体を消してしまうと、find時にアソシエーションがないっていうエラーが発生するので。 そうすると今度は余計なwhere条件が追加され、自分の想定したレコードが取ってこられない。

そこでエンティティークラスにアクセッサーを定義して、想定していないアソシエーションを無視した結果セットを取得しなおす。

アクセッサーの定義方法は以下。 http://book.cakephp.org/3.0/en/orm/entities.html#accessors-mutators

Lazy Loadingの解説も参照。 http://book.cakephp.org/3.0/en/orm/entities.html#lazy-load-associations というかやってることはまんまLazy Loading。

要は、_getXxxというゲッターメソッドを定義すれば、$entity->xxxというプロパティを参照しようとしたときに、実際に持っているxxxの値ではなくて_getXxxの戻り値が参照される。

_getXxxの中で、お好きなfindを実行すればOK。

ちなみにフォームヘルパーなど、持っている値を直接見に行ってしまう奴らにエンティティーを渡した際に、想定していない動きになる可能性があるので注意。 (注意ったってこっちはフォームヘルパーをオーバーライドして回避する程度の力技しか思いつかなかったけど)

バグが修正されたら、ちゃんと'foreignKey'=>falseに書き換える。 そしてエンティティーに作ったゲッターを削除する。これをやらないと結局ゲッターが優先されるので忘れずに。

[ajimicho-blog]

CakePHPの入力欄が自動でカラムに紐づかない時に疑うこと

Formヘルパーで出力するフォーム系のinputやらselectやらtextareaやらの入力欄。 規定ではデータベースのカラムの型やカラム名に応じた形で自動的に出力されるけど、うまいこと設定されない場合は全部input type="text"で出力される。 何が原因でうまいこと設定されていないのか、疑うべきチェックポイント。

エンティティーを渡し(せ)ていない

アソシエーションが正しくない

この2点を疑ってみて。

エンティティーを渡し(せ)ていない

CakePHP2を使ったことがある場合に1回くらい引っかかるかもしれない問題。

CakePHP2の場合、

<?=$this->Form->create('User')?>

のように、テーブル名を渡してフォームを開始していた。 でもCakePHP3では、エンティティーを渡すことになっている。

<?=this->Form->create($user)?>

もちろん、その前にコントローラー側でビューに渡す変数としてエンティティーを用意しなければいけない。

// リクエストデータからユーザーエンティティーを作成 $user = $this->Users->newEntity ( $this->request->data ); // ユーザーエンティティーをビューに渡す $this->set('user', $user);

リクエストデータ？なにそれ。 例えば、ユーザーが全ての入力を完了して送信ボタンを押したけど、サーバー側でバリデーションをした結果入力エラーとなったため、エラーメッセージを出して再入力を促す場合。 いちいちまっさらなエンティティーでフォームを表示するのは不親切なので、入力内容はそのままお返しするから必要なところだけ直してね、とする。 初回の処理でリクエストデータがなければ無視されるので安心。

アソシエーションが正しくない

今回の例でいうところの、ユーザーテーブル自体に存在するカラムを編集するinputの場合はいいけど、そのレコードに紐づく別のテーブルのデータを入力する場合。

テーブルクラスでアソシエーションを定義する。

アソシエーションを含めたエンティティーを生成する。

フォームヘルパーに正しく関連レコードを指定する。

という点を確認。

1. テーブルクラスでアソシエーションを定義する。

CakePHPのアソシエーションの概念についてはCakePHP 2のCakebookで丁寧な説明が読める。 http://book.cakephp.org/2.0/ja/models/associations-linking-models-together.html

CakePHP 3での書き方についてはここで。まだ英語版しかないけど、上を読んだ後なら本文飛ばしてサンプルコードだけ読めばOK。 http://book.cakephp.org/3.0/en/orm/associations.html

一点、hasAndBelongsToMany(HABTM) が belongsToMany と呼び名が変わった。端的でいいよね。

深追いすると趣旨がブレるので参考文献の紹介程度にしておく。

2. アソシエーションを含めたエンティティーを生成する。

エンティティー生成の際、関連テーブルもエンティティーに含めたネストされたエンティティーを生成する。

// リクエストデータからユーザーエンティティーを作成 $user = $this->Users->newEntity ( $this->request->data, [ 'contain' => 'Avatars' ]);

こんな感じで、例えばUser has one Avatarなエンティティーを生成。

アバターのさらにその先に別のテーブルを持つ場合はこう。

// リクエストデータからユーザーエンティティーを作成 $user = $this->Users->newEntity ( $this->request->data,[ 'contain' => [ 'Avatars', 'Avatars.Tags' ] ]);

Avatar belongs to many Tagsな想定で。ここはアソシエーションの種類が変わっても特に書き方に差はない。 ちょっとうまいこと架空のアソシエーションが思い浮かばなくてよく分からないサンプルになってるけどお許し。

余談 ちなみに'Avatars.Tags'だけでもちゃんとAvatarsとTagsを含めてくれる。個人的に階段状に書いていくのが整理されていて見やすい。

階段 A A.B A.B.C A.D A.D.E

本当は A.B.C A.D.E だけでも動くけど、Aを2回書いている時点で1回しか書かないことを徹底できないくらいなら最初からやりたくない。

3. フォームヘルパーに正しく関連レコードを指定する。

<?=$this->Form->input('-この部分-')?>

の指定方法。

まず、ユーザーテーブル (createメソッドに渡したエンティティー自体) のカラムの場合、何も工夫せずにカラム名をドン。

<?=$this->Form->input('name')?>

次にhasOneまたはbelongsToなテーブルのカラムの場合。 アソシエートされたエンティティーは、親エンティティーに対して小文字表記のプロパティー名で追加されるので、inputに渡す際もそれに従う。hasOneまたはbelongsToの場合は小文字表記に加えて単数形となる。 (表記はアソシエーション設定時に任意の名称に変更可能。)

<?=$this->Form->input('avatar.title')?>

アバターにタイトルなんかつけるかよ。

次が迷いがち。 hasManyまたはbelongsToManyなテーブルのカラムの場合、複数形の小文字表記に加えて、インデックスを指定してからカラム名をドン。

<?=$this->Form->input('avatar.tags.0.name')?>

アバターに紐づく複数のタグのうち、0番目のレコードのnameカラムですよ、と読む。 アバターにタグなんかつけるかよ。 0番目というのは本当にデータベース全体の話ではなく、今画面上で編集中のレコードのうち0番目。すでにひとつタグがついているアバターに対して、新規に0番目を編集すれば2つのタグができるし、エンティティー生成時にすでにあるタグをfindしてからエンティティーを作った場合は0番目に既存のタグの名前が表示され編集できる。 (その場合はふつうforeachとかで既存のタグ数分ループして複数の入力欄を出すのだろう。)

[ajimicho-blog]

CakePHPで定数やアプリケーション設定を定義する

PHPのdefineやconstを使用してもいいんだけど、どこに定義する？って問題が出てくる。 どのファイルにっていうのもそうだけど、どの名前空間に？どのクラスに？ CakePHPでは定数っぽく使えるConfigの定義と読み込み用のクラスが用意されている。 いや、後から上書きできるから定数ではないんだけどね…。

値を定義する

configディレクトリに定義用のphpファイルを作る。 例 config/constants.php

<?php $config['Code'] = 'ProcessingStatus' => [ 'waiting' => 1, 'progress' => 2, 'finished' => 3 ], 'UserRole' => [ 'admin' => 1, 'editor' => 2, 'auther' => 3, 'subscriber' => 4 ] ];

ネストした定数が定義できる。上記ではCodeという名前でコード値系の定数をまとめている。 以下でも全く同じ。なぜならPHPでは’$未定義の変数[添字] = 値’で自動的に配列が作られるので。

<?php $config['Code']['ProcessingStatus'] = [ 'waiting' => 1, 'progress' => 2, 'finished' => 3 ]; $config['Code']['UserRole'] = [ 'admin' => 1, 'editor' => 2, 'auther' => 3, 'subscriber' => 4 ];

次に作ったファイルを読み込む。拡張子なしでOK。 config/bootstrap.phpで読み込むのがスタンダードなのかな？ とりあえす一番下に追加。

config/bootstrap.php

Configure::load('constants');

値を使用する

class宣言の前にuse文でConfigureクラスを読み込む。 (読み込むというよりCakePHPのオートローダーがクラスのファイルを探しに行ってくれる様にしている、だと思う。)

あるコントローラー.php

<?php namespace App\Controller; use Cake\Core\Configure; class ○○Controller extends AppController {

ビューの場合はクラス宣言はしないけど適当に上の方でやる。

あるテンプレート.ctp

<?php use Cake\Core\Configure;?>

参照方法

// ユーザーに管理者権限を設定 $user->set('role', Configure::read('Code.UserRole.admin'));

$userはエンティティーの想定で、これで$user->roleに1がセットされる。 配列のネストを ‘.’ (ドット) 区切りで表現する。 逆にこのケースで、

Configure::read('Code.UserRole')

とした場合、配列

array (size=4)   'admin' => int 1   'editor' => int 2   'auther' => int 3   'subscriber' => int 4

が返される。

[ajimicho-blog]

PHPでは'$未定義の変数[添字] = 値'で自動的に配列が作られる

CakePHPじゃなくてPHPの話だけど。 何事にもとにかく配列を使用するCakePHPで使えそうなTips。

PHPでは定義されていない変数に対して添字を指定して配列として要素を追加することが許可されている。 ここでは$foo=未定義だが、$foo['bar']への代入を行うと、 暗黙的に$fooという新しい配列が作られ、その配列に対して'bar'という要素が追加される。

$foo['bar'] = 'hoge'; var_dump($foo);

結果

array (size=1)   'bar' => string 'hoge' (length=4)

ネストしていても可能。

$foo['bar']['fuga'] = 'hoge'; var_dump($foo);

結果

array (size=1)   'bar' =>     array (size=1)       'fuga' => string 'hoge' (length=4)

CakePHPで定数っぽく使用する$configを定義するときに、スマートに書けそう。