[CakePHP] XformHelperの使い方

CakePHPのBakeでは確認画面が作られません。
確認画面を作るのはかなり面倒なので何か良いツールがないかと探していたところ「XformHelper」に出会いました。
設定から利用までさほど苦労する所もなく簡単に使うことができました。

都道府県を登録するテーブルを使った例を記載します。
Bakeで作成したファイルを改造していきます。
新規追加「add」に確認画面をつけてみましょう。

テーブル名：prefecture
カラム名：id（主キー・AI）,name

フォームをエレメント化する。
/views/elements/　の下に
「controller名_function名.ctp」ファイルを作る。
今回の場合は/views/elements/prefectures_add.ctp

「prefectures_add.ctp」の内容

<?php
echo $this-&gt;Xformjp-&gt;input('name'); 
echo $this-&gt;form-&gt;error('Prefecture.name');
?>

<?php

echo $this->Xformjp->input('name');

echo $this->form->error('Prefecture.name');

フォームはXformjpにし、エラー表示はformにするのがポイント。
エラーはXformではなく、CakePHPのデフォルトのformで処理するので。

/views/prefectures/　の下に
「add_confirm.ctp」ファイルを作る。

「add.ctp」を以下のように変更する。（Bakeで作られたものを変更）

&lt;div class=&quot;prefectures form&quot;&gt; 
&lt;?php echo $this-&gt;Xformjp-&gt;create('Prefecture',array('action' =&gt; 'add_confirm'));?&gt; 
&lt;fieldset&gt; 
&lt;legend&gt;&lt;?php __('Add Prefecture'); ?&gt;&lt;/legend&gt; 
&lt;?php 
echo $this-&gt;element(&quot;prefectures_add&quot;); //★ 
?&gt; 
&lt;/fieldset&gt; 
&lt;?php echo $this-&gt;Xformjp-&gt;end(__('Submit', true));?&gt; 
&lt;/div&gt;

<?php echo $this->Xformjp->create('Prefecture',array('action' => 'add_confirm'));?>

<?php

echo $this->element("prefectures_add"); //★

</fieldset>

<?php echo $this->Xformjp->end(__('Submit', true));?>

</div>

フォーム項目をelementから呼び出します。上記★の部分。

「add_confirm.ctp」ファイルの内容。
下記のように記載します。

&lt;?php echo $this-&gt;Xformjp-&gt;create('Prefecture', array('action' =&gt; 'add_finish')); ?&gt; 
&lt;?php echo $this-&gt;element(&quot;prefectures_add&quot;);　//エレメントを読み込み ?&gt; 
&lt;?php 
echo $this-&gt;Xformjp-&gt;hidden('name'); //項目が複数ある場合は同様に項目数分を記載 
echo $vali; 
?&gt; 

&lt;?php 
//バリデーションが失敗した時に送信ボタンを表示しない為の処理（戻るボタンのみが表示される） 
if($variError=='失敗'){ 
}else{ 
echo $this-&gt;Xformjp-&gt;submit('送信', array('name' =&gt; 'add_finish')); 
} 
?&gt; 

&lt;?php 
echo $this-&gt;Xformjp-&gt;submit('戻る', array('name' =&gt; 'back', 'onClick' =&gt; 'history.back(); return false;')); 
echo $this-&gt;Xformjp-&gt;end(); 
?&gt;

<?php echo $this->Xformjp->create('Prefecture', array('action' => 'add_finish')); ?>

<?php echo $this->element("prefectures_add");　//エレメントを読み込み ?>

<?php

echo $this->Xformjp->hidden('name'); //項目が複数ある場合は同様に項目数分を記載

echo $vali;

<?php

//バリデーションが失敗した時に送信ボタンを表示しない為の処理（戻るボタンのみが表示される）

if($variError=='失敗'){

}else{

echo $this->Xformjp->submit('送信', array('name' => 'add_finish'));

}

<?php

echo $this->Xformjp->submit('戻る', array('name' => 'back', 'onClick' => 'history.back(); return false;'));

echo $this->Xformjp->end();

「モデルの変更」

&lt;?php 
class Prefecture extends AppModel { 
var $name = 'Prefecture'; 
var $displayField = 'name'; 
public $validate =array( 
'name'=&gt;array( 
'rule'=&gt;'notEmpty', 
'message'=&gt;'都道府県名を入力してください' 
) 
); 
}

<?php

class Prefecture extends AppModel {

var $name = 'Prefecture';

var $displayField = 'name';

public $validate =array(

'name'=>array(

'rule'=>'notEmpty',

'message'=>'都道府県名を入力してください'

)

);

}

バリデーションでmessage項目を追加しておくと、確認画面でエラー時にメッセージが表示される。

「コントローラーの変更」

Bakeで作った時には　function add()でdataが存在する場合はDBに登録する処理になっているが、confirm確認後にDB登録する流れに変更するのでfunction add()の中身は削除する。

function add_confirm()を追加する。
ここではバリデーション関連のやり取りをしています。バリデーションがOKであればDBへの登録ボタンを表示させる（データ登録・戻るの２つのボタンを表示）。バリデーション失敗の場合は戻るボタンのみを表示。

function add_confirm(){ 
$this-&gt;Prefecture-&gt;set( $this-&gt;data ); 
if ($this-&gt;Prefecture-&gt;validates()) { 
// バリデーション成功 
$this-&gt;set('vali','データが正しく入力されています。登録へ進んで下さい'); 
$this-&gt;set('variError','成功');//View側で登録ボタンの表示に利用 
} else { 
// バリデーション失敗 
$this-&gt;set('vali','データが正しくない、または空白があります、戻って修正して下さい'); 
$this-&gt;set('variError','失敗');//View側で登録ボタンの非表示に利用 
} 
$this-&gt;params['xformHelperConfirmFlag'] = true; //確認画面の宣言 
}

function add_confirm(){

$this->Prefecture->set( $this->data );

if ($this->Prefecture->validates()) {

// バリデーション成功

$this->set('vali','データが正しく入力されています。登録へ進んで下さい');

$this->set('variError','成功');//View側で登録ボタンの表示に利用

} else {

// バリデーション失敗

$this->set('vali','データが正しくない、または空白があります、戻って修正して下さい');

$this->set('variError','失敗');//View側で登録ボタンの非表示に利用

}

$this->params['xformHelperConfirmFlag'] = true; //確認画面の宣言

}

「function add_finish()」の内容
ここでは、Bakeで作られていたaddの内容（DBへデータ登録）を記載するだけです。（ほぼコピペでOK)

	function add_finish() {
		//「戻る」Javascriptで制御の為、下記は利用しない。
		if (isset($this->request->data['back'])) {
			$this->redirect(array('action' => 'add'));
		}

		if (!empty($this->data)) {
			$this->Prefecture->create();
			if ($this->Prefecture->save($this->data)) {
				$this->Session->setFlash(__('The prefecture has been saved', true));
				$this->redirect(array('action' => 'index'));
			} else {
				$this->Session->setFlash(__('The prefecture could not be saved. Please, try again.', true));
			}
		}

function add_finish() {

//「戻る」Javascriptで制御の為、下記は利用しない。

if (isset($this->request->data['back'])) {

$this->redirect(array('action' => 'add'));

}

if (!empty($this->data)) {

$this->Prefecture->create();

if ($this->Prefecture->save($this->data)) {

$this->Session->setFlash(__('The prefecture has been saved', true));

$this->redirect(array('action' => 'index'));

} else {

$this->Session->setFlash(__('The prefecture could not be saved. Please, try again.', true));

}

※XformHelperの設定などは下記参考元に詳しく記載されています。

[参考元]
とても参考になりました。Xformを使うと確認画面が本当に楽に作れます。感謝！
フォーム入力画面と確認画面で共通で使えるXformHelper

[追記] hiddenデータの持ち回りの例。

「prefecture_add.ctp」（エレメント）

echo $this->form->error('Prefecture.test');

1	echo $this->form->error('Prefecture.test');

「add.ctp」

echo $this->Xformjp->hidden('test',array('value'=>'abc');

1	echo $this->Xformjp->hidden('test',array('value'=>'abc');

※value部分はコントローラーで値をセットして変数を設定する形で使える。

「add_confirm.ctp」

echo $this->Xformjp->hidden('photo_file_name');

1	echo $this->Xformjp->hidden('photo_file_name');

人気記事一覧

関連記事一覧

Categories

最近の投稿

アーカイブ

最近のコメント

[CakePHP] XformHelperの使い方

人気記事一覧

関連記事一覧

Categories

人気記事

最近の投稿

アーカイブ

タグ

最近のコメント