Documentation

set_fieldset(Fieldset $fieldset)

スタンドアロンの Fieldset_Field オブジェクトを (Fieldset クラス経由ではなく) 作成した場合、 set_fieldset メソッドを使用してフィールドセットオブジェクトにフィールドオブジェクトを割り当てできます。

必須

$fieldset = \Fieldset::forge('myfieldset');
$field = new \Fieldset_Field('client', 'Name of the client');
$field->set_fieldset($fieldset);

set_name($name, $update = true)

Change the name of a field.

required

true

$fieldset->field('fieldname')->set_name('newfieldname');

If the fieldset field is part of a field, the field will be renamed in the fieldset too. Field order in the fieldset will be maintained.

set_label($label)

フィールドのラベルを設定／変更します。

必須

$fieldset->field('fieldname')->set_label('New Label');

set_type($type)

HTML フォームフィールドタイプを設定／変更します。

必須

// <input type="hidden"... > を生成
$fieldset->field('fieldname')->set_type('hidden');

set_value($value, $repopulate = false)

フィールドの値を設定／変更します。ラジオボタン、チェックボックスの場合、 repopulate を選択すると、 現在の値と渡された値に応じて "checked" を再計算します。

必須

false

$fieldset->field('fieldname')->set_value('this is the new value');

set_description($description)

フィールドの説明を設定／変更します。説明は、フィールドテンプレートの {description} タグに マッピングされます。たとえばヘルプテキストを表示する、などに使用できます。

必須

$fieldset
	->field('fieldname')
	->set_description('ここに何か入力してください。');

set_template($template = null)

このフィールドのカスタムフィールドテンプレートを設定またはリセットします。

null

$fieldset
	->field('fieldname')
	->set_template('<div class=\"{error_class}\">{label}{required}</div><div class="field-fieldname">{field} {description} {error_msg}</div>');

値を渡さないか、 null を渡した場合、 form.php 設定ファイルに定義されているデフォルトテンプレートを使用します。

set_error_message($rule, $msg)

指定したバリデーションルールのカスタムエラーメッセージを設定します。

必須

必須

// "valid_string" バリデーションルールのカスタムエラーメッセージを設定
$fieldset
	->field('fieldname')
	->set_error_message('valid_string', ':label は大文字と小文字の両方が含まれている必要があります！');

// "exact_length" 用のカスタムエラーメッセージを設定

$fieldset
	->field('fieldname')
	->set_error_message('exact_length', ':label は必ずしも :param:1 ではありません！');

get_error_message($rule)

バリデーションルールにカスタムメッセージがあるかどうかをチェックします。存在する場合、そのメッセージを返します。

必須

// "valid_string" バリデーションルールのカスタムエラーメッセージを設定
$fieldset
	->field('fieldname')
	->set_error_message('valid_string', ':label は大文字と小文字の両方が含まれている必要があります！');

// 返り値： :label は大文字と小文字の両方が含まれている必要があります！
$message = $fieldset->field('fieldname')->get_error_message('valid_string');

add_rule($callback)

フィールドにバリデーションルールを追加します。規定のバリデーションルール名か、あるいは このフィールドをバリデーションするコールバックを指定します。

必須

// フィールド上の valid_string ルールを設定
$fieldset->field('fieldname')->add_rule('valid_string', array('alpha-numeric', 'dots', 'spaces'));

// そして必須なフィールドを作成
$message = $fieldset->field('fieldname')->add_rule('required');

required ルールを設定すると、フォームの input タグに "required" 属性がセットされます。

delete_rule($callback, $set_attr = true)

フィールドのバリデーションルールを取り除きます。規定のバリデーションルール名か、あるいは このフィールドをバリデーションするコールバックを指定します。

必須

true

// フィールドから valid_string ルールを取り除く
$fieldset->field('fieldname')->delete_rule('valid_string');

// そして、必須項目の指定を取り除く
$message = $fieldset->field('fieldname')->delete_rule('required', true);

required ルールを取り除くとき、 $set_attr が true に設定されているとフォームの input タグの "required" 属性も取り除かれます。

set_attribute($attr, $value = null)

このフィールドに、 1 つ以上の HTML 属性を設定します。

必須

null

// カスタムな CSS スタイルを追加
$fieldset->field('fieldname')
	->set_attribute('style', 'font-weight:bold;color:yellow;');

// もしくは一度に複数の属性を追加
$fieldset->field('fieldname')->set_attribute(array(
	'style' => 'font-weight:bold;color:yellow;',
	'disabled' => 'disabled'
));

null を値として渡した場合、属性リストから属性を取り除きます。

get_attribute($key = null, $default = null)

このフィールドの、 1 つ以上の HTML 属性を取得します。

null

null

// カスタムスタイルが定義されていたら取得、スタイルが未定義なら false
$style = $fieldset->field('fieldname')
	->get_attribute('style', false);

set_options($value, $label = null, $replace_options = false)

オプションを設定します。ラジオボタン、チェックボックス、セレクトボックスのみ有効。

必須

null

false

// フィールドが select の場合： <option value="1">Label</option>
// フィールドが checkbox の場合： <label>Label</label><input type="checkbox" ... />
$style = $fieldset->field('fieldname')->set_options('1', 'Label');

fieldset()

このフィールドが関連付けられたフィールドセットオブジェクトを取得します。

// true が返る
$same = ($fieldset === $fieldset->field('fieldname')->fieldset());

add($name, $label = '', array $attributes = array(), array $rules = array())

Fieldset add() メソッドのエイリアス。

add_before($name, $label = '', array $attributes = array(), array $rules = array(), $fieldname = null)

Fieldset add_before() メソッドのエイリアス。

add_after($name, $label = '', array $attributes = array(), array $rules = array(), $fieldname = null)

Fieldset add_after() メソッドのエイリアス。

build()

このフィールドのフォーム HTML を生成します。

// フィールドが select の場合： <option value="1">Label</option>
// フィールドが checkbox の場合： <label>Label</label><input type="checkbox" ... />
$style = $fieldset->field('fieldname')->set_options('1', 'Label');

input()

Validation input() メソッドのエイリアス。 現在のフィールドの入力値を返す。入力値が無い場合は null を返す。

validated()

Validation validated() メソッドのエイリアス。 現在のフィールドのバリデーションされた入力値を返す。バリデーションされた入力値が無い場合は null を返す。

error()

Validation error() メソッドのエイリアス。 このフィールドのバリデーション実行後のエラーメッセージを返す。エラーが検出されない場合は false を返す。