HOME>WEBプログラム覚書>[CakePHP2]FormHelper をちょっとだけ便利に。

[CakePHP2]FormHelper をちょっとだけ便利に。

[CakePHP2.X] HtmlHelper、FormHelper、Viewは直接使わないほうがｲｲ。という記事を書いたので、 FormHelperを直接使わない場合、どのようなことができるのか書いておきます。地味なことしかやってないんで地味な例ですけど・・・

入力例や注意事項などを出力したい

フォームには入力例や、注意事項など書くことが多々あるかとおもいます。

一応、$options に before や after があるので前後に挿入することは可能ですが、他のはうざいほど余計なタグでラップするくせに、ここはタグでラップしてくれず入力したものがそのまま出力されます。なのでタグを入れたい場合、直接HTMLタグを入力してもよいですが、デザイン変更時やCSSライブラリやJavascript ライブラリとクラス名がかぶったりした場合、全て修正しないとだめなので面倒です。

例えば、

HTML

<div class="input email">
<label for="UserEmail">メールアドレス</label>
<input name="data[User][email]" type="email" id="UserEmail" />
<p class="example">入力例) jousou@example.com</p>
<ul class="help-list">
<li>20文字以内で入力してください。</li>
<li>半角英数字で入力してください。</li>
</ul>
</div>

のようなHTMLを出力したい場合、

View/User/form.php

<?php
echo $this->Form->input('User.email', array(
'label' => 'メールアドレス',
'after' => '
<p class="example">入力例) jousou@example.com</p>
<ul class="help-list">
<li>20文字以内で入力してください。</li>
<li>半角英数字で入力してください。</li>
</ul>
',
));
?>

と記述しなくてはなりません。PHPにタグを埋め込むとか苦痛ですよね。なので、これをもっと簡単にかけて、変更も容易になるようなメソッドを追加します。

準備

FormHelperを継承したAppFormHelperを利用することにします。

AppController.php

<?php
AppController extends Controller
{
public var $helper = array(
'Form' => array('className' => 'AppFormHelper')
);
}
?>

こんな感じでFormHelperを自作のフォームヘルパーに変更します。

AppFormHelper

$optionsに help、helpText、helpList、example というキーがあった場合、それぞれ処理をおこなうようになっています。

View/Helper/AppFormHelper.php

<?php
App::uses('FormHelper', 'View/Helper');
class AppFormHelper extends FormHelper
{
/**
* ここに記述したキーが $options にあった場合、
* コールバックを実行
*
* @var array
*/
public $app_tags = array(
'help', 'helpText', 'helpList', 'example'
);
/**
* $options に self::$app_tags で定義されたキーがあった場合、
* self::$key()を実行する
*
* @param string $fieldName
* @param array $options
* @return string
* @throws Exception
*/
public function input($fieldName, $options = array())
{
foreach ($options as $key => $value) {
if (in_array($key, $this->app_tags)) {
if (method_exists($this, $key)) {
$options = call_user_func(array($this, $key), $options);
} else {
throw new Exception(sprintf('AppFormHelper::%s()がありません。', $key));
}
}
}
return parent::input($fieldName, $options);
}
/**
* ヘルプの出力
*
* $options['help'] が配列の場合 self::helpList()
* それ以外の場合 self::helpText() を実行する
*
* @param array $options
* @return array
*/
protected function help(Array $options)
{
if (is_array($options['help'])) {
$options['helpList'] = $options['help'];
$options = $this->helpList($options);
} else {
$options['helpText'] = $options['help'];
$options = $this->helpText($options);
}
unset($options['help']);
return $options;
}
/**
* 入力についての注意事項
*
* $options['helpText']の内容を pタグでラップして
* after に入れ替える
*
* @param array $options
* @return array
*/
protected function helpText(Array $options)
{
$helptext = String::insert('<p class="help-text">:helptext</p>', array('helptext' => $options['helpText']));
if (array_key_exists('after', $options)) {
$options['after'] .= $helptext;
} else {
$options['after'] = $helptext;
}
unset($options['helpText']);
return $options;
}
/**
* 入力についての注意事項複数
*
* $options['helpText']の内容を ulタグでラップして
* after に入れ替える
*
* @param array $options
* @return array
*/
protected function helpList(Array $options)
{
$ul = $this->Html->nestedList($options['helpList'], array('class' => 'help-list'));
if (array_key_exists('after', $options)) {
$options['after'] .= $ul;
} else {
$options['after'] = $ul;
}
unset($options['helpList']);
return $options;
}
/**
* 入力例を追加
*
* $options['example']の内容を pタグでラップして
* after に入れ替える。inputタグの直後に表示される。
*
* @param array $options
* @return array
*/
protected function example(Array $options)
{
$text = String::insert('<p class="example">入力例) :text</p>', array('text' => $options['example']));
if (array_key_exists('after', $options)) {
// 入力例はinputの直後に表示
$options['after'] = $text . $options['after'];
} else {
$options['after'] = $text;
}
unset($options['example']);
return $options;
}
}
?>

利用方法

下記のようにHTMLタグを含めることなく記述することができて、出力を変更したい場合、AppFormHelper を変更すれば済むようになります。

View/User/form.php

<?php
echo $this->Form->input('User.email', array(
'label' => 'メールアドレス',
'example' => 'jousou@example.com',
'help' => array(
'20文字以内で入力してください。',
'半角英数字で入力してください。'
)
));
?>

View/User/form.php

実行結果

<?php
echo $this->Form->input('User.name', array(
'label' => 'お名前',
'example' => '内田靖人',
'helpText' => '20文字以内で入力してください。'
));
?>
<hr />
<?php
echo $this->Form->input('User.email', array(
'label' => 'メールアドレス',
'helpList' => array(
'20文字以内で入力してください。',
'半角英数字で入力してください。'
),
'example' => 'jousou@example.com',
));
?>
<hr />
<?php
echo $this->Form->input('User.email', array(
'label' => 'メールアドレス',
'help' => array(
'aaaa',
'bbbb'
),
'example' => 'jousou@example.com',
));
?>
<hr />
<?php
echo $this->Form->input('User.email', array(
'label' => 'メールアドレス',
'help' => 'aaa',
'example' => 'jousou@example.com',
));
?>

投稿日	2014年2月 3日 06:01
カテゴリ	PHP
タグ	CakePHP
トラックバック URL	http://www.kantenna.com/cgi-bin/mt504/mt-tb.cgi/1348

コメントする

Name

Email Address

URL

コメント(スタイル用のHTMLタグを使えます)

ログイン情報を記憶

[CakePHP2]FormHelper をちょっとだけ便利に。

入力例や注意事項などを出力したい

HTML

View/User/form.php

準備

AppController.php

AppFormHelper

View/Helper/AppFormHelper.php

利用方法

View/User/form.php

View/User/form.php

コメント

コメントする

KANTENNA.COM

プログラム

カテゴリ

Memo

プログラムの原則

jQuery不要のアニメーションスクロールライブラリAOS

Error 1449 The user specified as a definer (‘username’@’hostname’) does not exist

Invalid default value for カラム名

14: curl#6 – “Could not resolve host: mirrors.iuscommunity.org; 不明なエラー”

[CakePHP2]FormHelper をちょっとだけ便利に。

入力例や注意事項などを出力したい

HTML

View/User/form.php

準備

AppController.php

AppFormHelper

View/Helper/AppFormHelper.php

利用方法

View/User/form.php

View/User/form.php

コメント

コメントする

プログラム

カテゴリ

Memo

プログラムの原則

jQuery不要のアニメーションスクロールライブラリAOS

Error 1449 The user specified as a definer (‘username’@’hostname’) does not exist

Invalid default value for カラム名

14: curl#6 – “Could not resolve host: mirrors.iuscommunity.org; 不明なエラー”

PAGE RANK

TIME LINE

Tag