CakePHP 1.3 JsHelperを使ってみる

CakePHPの1.3rc版がリリースされたので、ぼちぼち試しています。
1.2→1.3のマイグレーションガイドなどを見ながらやってみたら、いろいろと変更しなきゃならない点はありましたが、とりあえずエラーが出なくなるところまでは移行できてきました。
今回は、新しく追加になったJs Helperをちょっと使ってみました。

今までのCakePHPでは、AjaxヘルパーなどでPrototype.jsを使っていましたが、今回のアップデートで新しくなったJs Helperは、使うJavascriptライブラリを選ぶことができます。現時点で標準で対応しているのは jQuery、Prototype/Scriptaculous、Mootoolsで、コントローラからエンジンを選ぶことでどのライブラリを使うかを選択できます。

var $helpes = array('Js'=>array('Prototype'));

エンジン名を省略した場合はjQueryエンジンがデフォルトで使われます。時代の流れですかね？

jQueryを使う場合は、jquery.jsとjquery-ui.jsをwebroot/js内に入れて、ビューテンプレートの中で

 echo $html->script('jquery'); 
 echo $html->script('jquery-ui'); 

とやって読み込んでおきます。以前は$javascript->linkでしたが、$html->scriptも今回新しくなった部分です。

で、今まではAjaxヘルパーを使って、 echo $ajax->link(・・・・);みたいな感じでしたが、Jsヘルパーではちょっと仕組みが変わってます。
というのは、スクリプトは一旦ヘルパー内のバッファに溜められます。で、最後にそのバッファを画面に出力するという手順になります。
例えば、ajaxでリンクをする場合、

 <div id="update-div"></div> 
　echo $js->link('LINK',リンクURL,array('update'=>'#update-div'));

Jsヘルパーの場合、これだけですと、リンクタグは表示されますが、スクリプトはまだ表示されませんので動きません。
バッファー内に溜まっているスクリプトを吐き出してやらなければなりません。
（ついでに・・・updateでアップデートするdivを指定する時、以前は'#'は不要でしたが、JsHelperではidを意味する'#'を必ずつけます。クラスを指定する場合は'.'（ドット）です。）

いろいろ$jsのメソッドを書き終わったら最後に

echo $js->writeBuffer(array('inline'=>false));

でバッファを書きだします。
cakePHPマニュアルでは、レイアウトのテンプレート（初期状態だとdefault.ctp）の</body>タグの直前に置くのがいいと書いてあります。
インラインにするかなどの、書き出しのオプションはマニュアルにあります。
オプションに'cache' = trueを設定すると、Jsのファイルを自動的に作ってくれます。これはおもしろいですね。

追記：
ただ、$js->link()や、$js->submit()など、その場にリンクタグやボタンを表示するメソッドの場合は、

echo $js->link('LINK',リンクURL,array('update'=>'#update-div','buffer'=>false));

のように、オプションでバッファを使用するかどうかを設定できますね。falseにしたらバッファは使用しないで、その場にスクリプトも出力されます。あとでwriteBufferする必要は無いです。