Documentation

forge($name = 'default', $config = array())

forge メソッドは、新しい Fieldset インスタンスを返します。注意: 1 つの $name に 1 つのインスタンスのみです。

'default'

$article_form = Fieldset::forge('article');

Fieldset オブジェクトを構築するとき、カスタム設定されたオブジェクトをセットアップするための設定を記述する配列を渡すことができます。 以下のアイテムがサポートされています。

null

null

これらのフィールドの他に、カスタムフォーム設定を渡すことで、 Fieldset がフォームを生成する方法を変更できます。 有効な設定値は、form.php 設定ファイルをご覧ください。

instance($instance = null)

指定したインスタンス、またはデフォルトインスタンスを返す。 (必要なら作成する)

null

$article_form = Fieldset::instance('article');

validation()

現在の Fieldset の Validation インスタンスを取得する。存在しなければ、Validation インスタンスを作成する。

$validation = $article_form->validation();

form()

現在の Fieldset の Form インスタンスを取得する。存在しなければ、 Form インスタンスを作成する。

$form = $article_form->form();

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

Fieldset_Field インスタンスを作成し、現在の Fieldset に追加する。

''

array()

array()

$title_field = $article_form->add('article_title', 'Title', array('class' => 'pretty_input'));

// ラジオボタンの例
$ops = array('male', 'female');
$form->add(
	'gender', '',
	array('options' => $ops, 'type' => 'radio', 'value' => 'true')
);

// チェックボックスの例
$ops = array('male', 'female');
$form->add(
	'gender', '',
	array('options' => $ops, 'type' => 'checkbox', 'value' => 'true')
);

// 検証ルール付きの Email 入力の例
$form->add(
	'email', 'E-mail',
	array('type' => 'email', 'class' => 'pretty_input'),
	array('required', 'valid_email')
);

// 検証ルールを配列で記述した text 入力の例
$form->add(
	'name', 'Full name',
	array('type' => 'name', 'class' => 'pretty_input'),
	array(array('required'), array('valid_string', array('alpha-numeric', 'dots', 'spaces')))
);

delete($name)

Fieldset から Fieldset_Field インスタンスを取り除く。

$fieldset->delete('article_title');

duplicate($name, $newname)

Duplicates a named Fieldset_Field instance from the Fieldset.

$fieldset->delete('article_title');

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

Fieldset_Field インスタンスを作成し、 $fieldname で定義済みのフィールドを指定し、そのフィールドの直前に現在の Fieldset に追加します。

''

array()

array()

null

// 'location' フィールドの前に追加されるラジオボタンフィールド
$ops = array('male', 'female');
$form->add_before('gender', '', array('options' => $ops, 'type' => 'radio', 'value' => 'true'), array(), 'location');

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

Fieldset_Field インスタンスを作成し、現在の Fieldset の $fieldname で識別される定義済みフィールドの後に追加する。

''

array()

array()

null

// 'location' フィールドの後に追加されるラジオボタンフィールド
$ops = array('male', 'female');
$form->add_after('gender', '', array('options' => $ops, 'type' => 'radio', 'value' => 'true'), array(), 'location');

field($name = null)

現在の Fieldset から Fieldset_Field インスタンスを 1 つまたは全て取得する。

null

$fields = $article_form->field();
$title_field = $article_form->field('article_title');

add_model($class, $instance = null, $method = 'set_form_fields')

モデルフィールドを追加する。 モデルは set_form_fields() メソッドを必ずもち、そのメソッドはこの Fieldset インスタンスにフィールドを追加します。
Orm\Model はビルトインでこれをサポートしています。

null

'set_form_fields'

$article_form = Fieldset::forge('article');
$article_form->add_model('Model_Article');

set_config($config, $value = null)

fieldset の設定値をセットする

null

$article_form->set_config($config);

// or

$article_form->set_config('key', 'value');

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

設定の配列を取得する、またはキーを指定して設定値を取得する。

null

null

$config = $article_form->get_config();

get_name()

fieldset インスタンスの識別子を取得する。

$article_form = Fieldset::forge('article');
$name = $article_form->get_name();  // 'article'

populate($input, $repopulate = false)

指定した input に初期値を設定する。オプションで再設定するように設定可能。

$article_form->populate($model);

repopulate()

フォーム送信からの入力値をフィールドに設定する。(method 属性を使用して POST か GET かをチェックするかを決定する)

$article_form->repopulate();

build($action = null)

$this->form()->build() のエイリアス。HTML フォームマークアップを生成する。Form を参照。

null

$this->template->form = $article_form->build(Uri::create('article/submit'));

disable($field)

disable メソッドは、ビルドされるフィールドを無効にします。 フォームのフィールドの順序を変更したり、複雑なレイアウトのフィールドを作成したり、といったことができます。

$fieldset->disable('name');

フィールドはフィールドセットから取り除かれませんので、バリデーションは行われます。

enable($field)

enable メソッドは、disableメソッドで無効化されたフィールドを再び有効にします。

$fieldset->enable('name');

input($field = null)

$this->validation()->input() のエイリアス。POST データまたは入力をバリデーションした値を配列で取得します。Validation を参照。

null

$input_values = $article_form->input();

validated($field = null)

$this->validation()->validated() のエイリアス。バリデーションされた値を配列で取得します。Validation を参照。

null

$validated_values = $article_form->validated();

error($field = null)

$this->validation()->error() のエイリアス。バリデーションされなかった値を配列で取得します。Validation を参照。

null

$errors = $article_form->error();

show_errors(Array $config = array())

$this->validation()->show_errors() のエイリアス。全てのエラーリストを $config パラメータで設定したマークアップで返します。Validation を参照。

array()

$all_errors = $article_form->show_errors();

set_tabular_form($model, $relation, $parent, $blanks = 1, $pagination = null)

Define an embedded fieldset on a related ORM model to create a One-to-Many form.

1

null

テーブルは config/form.php 設定ファイルのテンプレート定義に従って表示されます。 これらのテンプレートを自由に変更することができますが、表構造は維持する必要があります。 というのも、fieldset クラスが各行のフィールドに基づいてテーブルヘッダを追加するからです。 もしテンプレートの行定義からテーブルを取り除いた場合、妥当でない HTML を生成してしまいます。

get_tabular_form()

テーブル名を返す。

if ($name = $form->get_tabular_form())
{
	echo '$form は表形式のフィールドセットで名前は ', $name;
}

ORM モデルからフォームを作成する

Fieldset クラスは、 ORM モデルからフォームを作成するために使用することができます。 次の例ではモデルの $_properties で指定されたフィールドに基づきフォームを構築します。 例では、 $article は Model_Article のインスタンスです。

echo Fieldset::forge('article')->add_model($article)->populate($article, true)->build();

モデルのすべてのプロパティをフォーム上に望まない場合、フォームの種類を false に設定することでそれらは生成されなくなります。
これは実際には裏で Observer_Validation を使用しますが、これが機能するためのオブザーバーとしてそれを追加する必要はありません。

ORM モデルから One-to-Many フォームを作成する

ORM モデルオブジェクトと多くのリレーションのためのフォームを作成するために Fieldset クラスはまた利用することができます。 これは、関連するモデルとリレーションの名前を指定して、メインフォームのフィールドセットに表形式のフィールドセットを埋め込むことによって行われます。

デフォルトでは、 One-to-Many フィールドセットは config/form.php ファイル内のテンプレートによって制御され、表形式で表示されます。

// $id で識別される記事とそのコメントの one-to-many フォームを作成しようとしている。

// 記事とその関連のコメントを取得
$article = Model_Article::find($id, array('related' => array('comments')));

// ORM モデルフォーム定義を使用してこの記事のためのフォームフィールドセットを作成
$form = Fieldset::forge('article')->add_model($article);

/*
 * one-to-many テーブルを作成するために表形式を追加。
 *
 * データは、 $article オブジェクトに関連づけされた、 'Model_Comment' クラスのオブジェクトである
 * 'comments' によって提供される。
 *
 * フォームに埋め込まフィールドセットを回避するためにフィールドセットタグを無効にすることができます
 */
$form->add(\Fieldset::forge('tabular')->set_tabular_form('Model_Comment', 'comments', $article)->set_fieldset_tag(false));
				

それは複合キーを持っていない関連付けられたモデルのみで動作します！

それは指定されたリレーションの名前の配列とそのインデックス値としてレコードの主キーの値を使用し表形式の HTML 入力タグを生成します。 表の一番下に追加された空白行は '_new' 接尾辞と共にリレーション名を使用します。 これは、 1 回で、親レコード、およびすべての関連付けられたレコードを更新することを可能にし、個別に新しい行を処理します。

この例では、既存の行のために comments[12][fieldA] ような入力タグ名が表示されます (この場合は最初の空白行のフィールドのための id = 12 と comments_new[0][fieldA] を持つ行。

// 投稿された one-to-many フォームを処理
if (\Input::post())
{
	// 入力を検証
	$form->validation()->run();

	// 検証済みの場合、更新を保存
	if ( ! $form->validation()->error())
	{
		// 記事の記録、および任意のコメントレコードの変更を更新
		$article->from_array($data);

		// 表形式のレコードを削除する必要があるか？
		foreach ($data['comments'] as $id => $row)
		{
			if ($id and ! empty($row['_delete']))
			{
				unset($article->comments[$id]);
			}
		}

		// 新しい表形式のレコードデータ持っているか (私たちは、1 つの空白行を追加していることを仮定) ？
		$data = array_filter($data['comments_new'][0]);

		$new_errors = false;
		if ( ! empty($data))
		{
			// 必須フィールドをチェック
			if (empty($data['fieldA']) or empty($data['fieldB']))
			{
				$new_errors = true;
				// ここで必要なフィールドが存在しないというエラーメッセージが表示する...
			}
			else
			{
				// 新たな関連付けされたレコードを作成
				$article->comments[] = Model_Comment::forge(array('article_id' => $article->id, 'fieldA' => $data['fieldA'], 'fieldB' => $data['fieldB']));
			}
		}

		// 更新を保存
		if ( ! $new_errors)
		{
			if ($article->save())
			{
				// ここでセーブ成功したメッセージを表示し、リダイレクトし離れる
			}
			else
			{
				// エラーメッセージを表示、保存が成功しなかった
			}
		}
	}
	else
	{
		// ユーザー検証失敗の通知
	}
}

フォームの属性

フィールドセットによって生成されたフォームのレイアウトは、 form.php 設定ファイルによって制御されます。

下記の設定値が定義されています：

true

true

'form_'

'post'

'\n\t\t{open}
\n\t\t<table>\n{fields}\n\t\t</table>
\n\t\t{close}\n'

'\t\t<tr>
\n\t\t\t<td class=\"{error_class}\">
{label}{required}</td>
\n\t\t\t<td class=\"{error_class}\">{field}
<span>{説明}</span> {error_msg}
</td>\n\t\t</tr>\n'

'\t\t<tr>
\n\t\t\t<td class=\"{error_class}\">
{group_label}{required}</td>
\n\t\t\t<td class=\"{error_class}\">{fields}
\n\t\t\t\t{field} {label}
\n{fields}<span>{description}</span>
\t\t\t{error_msg}\n\t\t\t</td>\n\t\t</tr>\n'

'<span>{error_msg}</span>'

'<span>{label}</span>'

'*'

false

null

null

'<table>{fields}</table>\n'

'{field}'

'<tr>{fields}</tr>\n'

'\t\t\t<td>{label}{required} {field} {error_msg}</td>\n'

'Delete?'

フォームの属性のマクロ

フォームテンプレートで次のマクロを利用することができます。

フォームの属性を変更する

2 つの方法でフィールドセットで form() インスタンスの属性を変更することができます。 forge() メソッドの属性の配列、もしくは、 直接フォームインスタンスを変更することでオプションを提供することができます。

// Fieldset オブジェクトの属性で form_attributes オプションを使用
$fieldset = Fieldset::forge('article', array(
	'form_attributes' => array(
		'id' => 'edit_article_form',
		'name' => 'edit_article'
		)
	)
);

// 直接フォームインスタンスを変更
$fieldset->form()->set_attribute('id', 'edit_article_form');