付録 A - ウィジェット

はじめに

symfony フォームフレームワークにはたくさんの便利なウィジェットが搭載されています。これらのウィジェットは大半のプロジェクトの共通のニーズをカバーします。この章では symfony に搭載されているデフォルトのフォームウィジェットを説明します。sfFormExtraPlugin、sfPropelPlugin と sfDoctrinePlugin プラグインのフォームウィジェットも含まれています。これらのプラグインには symfony のコアチームによってサポートされているとても便利なウィジェットもいくつか含まれています。

それぞれのウィジェットのくわしい内容に飛び込む前に、ウィジェットの共通機能を見てみましょう。

sfWidget 基底クラス

すべての symfony ウィジェットは sfWidget 基底クラスを継承します。 この基底クラスはいくつかのデフォルト機能をすべてのウィジェットに提供します。

デフォルトでは、すべてのウィジェットは XHTML としてレンダリングされます。 setXhtml() メソッドを呼び出して HTML に切り替えることができます。

sfWidget::setXhtml(false);

ウィジェットシステムはエスケープされた HTML 属性と気の利いた内容で自動的に構成されます。効率よくするには、プロジェクトで使われている文字集合をシステムに伝えることが必要です。文字集合のデフォルトは UTF-8 で、setCharset() メソッドを呼び出すことで文字集合のデフォルトを変更できます。

sfWidget::setCharset('ISO-8859-1');

ウィジェットが JavaScript ファイルもしくは/かつスタイルシートに依存する場合、getJavaScripts() と getStylesheets() メソッドをそれぞれオーバーライドできます。

class Widget extends sfWidget
{
  public function getStylesheets()
  {
    // 配列のキーはファイルのパスで
    // 値はコロン (,) で区切られたメディアの名前
    return array(
      '/path/to/file.css' => 'all',
      '/another/file.css' => 'screen,print',
    );
  }
 
  public function getJavaScripts()
  {
    return array('/path/to/file.js', '/another/file.js');
  }
}

sfWidgetForm 基底クラス

この節では、フォームウィジェットに限定して説明します。これらすべてのウィジェットは sfWidgetForm 基底クラスを継承します。追加のデフォルト機能をいくつか提供するために、この基底クラスは sfWidget クラスを継承します。

ウィジェットを作るとき、複数のオプションと HTML 属性を追加の引数に渡すことができます。

$w = new sfWidgetFormInputText(
  array('default' => 'Fabien'),
  array('class' => 'foo')
);

setOptions() と setAttributes() メソッドを呼び出すことで、オプションと HTML 属性をそれぞれセットすることもできます。

$w = new sfWidgetFormInputText();
$w->setOptions(array('default' => 'Fabien'));
$w->setAttributes(array('class' => 'foo'));

setOption() と setAttribute() メソッドを呼び出すことで、個別のオプションと HTML 属性をそれぞれセットできます。

$w = new sfWidgetFormInputText();
$w->setOption('default', 'Fabien');
$w->setAttribute('class', 'foo');

render() メソッドを呼び出せば、ウィジェットはレンダリングされます。

$w->render('name', 'value', array('class' => 'foo'));

render() メソッドは次の引数をとります。

• ウィジェットの名前
• ウィジェットの値
• オプションのいくつかの HTML 属性 (これらはコンストラクションの際に定義されているデフォルトにマージされます)

上記のウィジェットは次のようにレンダリングされます。

<input class="foo" type="text" name="bar" id="bar" value="value"/>

sfWidgetForm で定義されているデフォルトのオプションは次のとおりです。

sfWidgetForm クラスはすべてのオプションに対するアクセサメソッドも提供します。

• is_hidden: isHidden()、setHidden()
• needs_multipart: needsMultipartForm()
• default: getValue()、setValue()
• label: getLabel()、setLabel()
• id_format: getIdFormat()、setIdFormat()

ウィジェットスキーマ

フォームウィジェットスキーマは1つもしくは複数の別のウィジェットのラッパーウィジェットです。

次の節では、ウィジェットは複数のカテゴリに再分類されます。

ウィジェット

• sfWidgetFormChoice
• sfWidgetFormDate
• sfWidgetFormDateRange
• sfWidgetFormDateTime
• sfWidgetFormDoctrineChoice
• sfWidgetFormFilterInput
• sfWidgetFormFilterDate
• sfWidgetFormI18nChoiceCountry
• sfWidgetFormI18nChoiceLanguage
• sfWidgetFormI18nChoiceCurrency
• sfWidgetFormI18nChoiceTimezone
• sfWidgetFormI18nDate
• sfWidgetFormI18nDateTime
• sfWidgetFormI18nTime
• sfWidgetFormInput
• sfWidgetFormInputCheckbox
• sfWidgetFormInputFile
• sfWidgetFormInputFileEditable
• sfWidgetFormInputHidden
• sfWidgetFormInputPassword
• sfWidgetFormJQueryAutocompleter
• sfWidgetFormJQueryDate
• sfWidgetFormPropelChoice
• sfWidgetFormReCaptcha
• sfWidgetFormSchema
• sfWidgetFormSchemaDecorator
• sfWidgetFormSelect
• sfWidgetFormSelectDoubleList
• sfWidgetFormSelectMany
• sfWidgetFormSelectCheckbox
• sfWidgetFormSelectRadio
• sfWidgetFormTextarea
• sfWidgetFormTextareaTinyMCE
• sfWidgetFormTime

入力ウィジェット

sfWidgetFormInput

input タグはおそらくもっともシンプルなフォームタグで sfWidgetFormInput クラスによってあらわされます。

$w = new sfWidgetFormInputText();
echo $w->render('foo');
 
# <input type="text" name="foo" id="foo" />

sfWidgetFormInputCheckbox

sfWidgetFormInputCheckbox は type 属性に checkbox の値が指定されている入力ウィジェットです。

$w = new sfWidgetFormInputCheckbox();
echo $w->render('foo');
 
# <input type="checkbox" name="foo" id="foo" />

sfWidgetFormInputHidden

sfWidgetFormInputHidden は type 属性に hidden の値が指定されている入力ウィジェットです。is_hidden オプションに true がセットされています。

$w = new sfWidgetFormInputHidden();
echo $w->render('foo');
 
# <input type="hidden" name="foo" id="foo" />

sfWidgetFormInputPassword

sfWidgetFormInputPassword は type 属性に password の値が指定されている入力ウィジェットです。

$w = new sfWidgetFormInputPassword();
echo $w->render('foo');
 
# <input type="password" name="foo" id="foo" />

sfWidgetFormInputFile

sfWidgetFormInputFile は type 属性に file の値が指定されている入力ウィジェットです。needs_multipart オプションに true が自動的にセットされます。

$w = new sfWidgetFormInputFile();
echo $w->render('foo');
 
# <input type="file" name="foo" id="foo" />

sfWidgetFormInputFileEditable

sfWidgetFormInputFileEditable は入力ファイルウィジェットで、以前アップロードされたファイルを表示もしくは削除する機能を追加するために、sfWidgetFormInputFile ウィジェットを拡張します。

sfWidgetFormTextarea

sfWidgetFormTextarea ウィジェットは必須の rows と cols 属性のデフォルト値を自動的にセットします。

$w = new sfWidgetFormTextarea();
echo $w->render('foo');
 
# <textarea rows="4" cols="30" name="foo" id="foo"></textarea>

sfWidgetFormTextareaTinyMCE

WYSIWYG エディタウィジェットをレンダリングしたい場合、sfWidgetFormTextareaTinyMCE ウィジェットを使います。

$w = new sfWidgetFormTextareaTinyMCE(
  array(),
  array('class' => 'foo')
);

TinyMCE の JavaScript ファイルはプラグインに搭載されていないので、自分でインストールしなければなりません。

セレクトウィジェット

選択肢の表現

ユーザーに選択可能なリストから選ばせたい場合に、HTML による選択肢の表現方法として次のようなものがあります。

• select タグ:

  

• multiple 属性をもつ select タグ:

  

• type 属性に radio が指定されている input タグのリスト:

  

• type 属性に checkbox が指定されている input タグのリスト:

  

しかし究極的には、これらすべてはユーザーが限られた選択肢の範囲で単独もしくは複数の選択を行うことを可能にします。

sfWidgetFormChoice ウィジェットは1つのウィジェットの範囲内ですべての利用可能なものを標準化します。これまで見てきたように、ウィジェットは選択を4つの HTML 表現のどれかにレンダリングする機能があります。これによって後で見るように独自の表現を定義することできます。

sfWidgetFormChoice はレンダリング作業を別のウィジェットにゆだねる特別なウィジェットです。 レンダリングは2つのオプション: expanded と multiple でコントロールされます。

それぞれを実現するための HTML 表現は次のとおりです。

$w = new sfWidgetFormChoice(array(
  'choices' => array('Fabien Potencier', 'Fabian Lange'),
));

$w = new sfWidgetFormChoice(array(
  'multiple' => true,
  'choices'  => array('PHP', 'symfony', 'Doctrine', 'Propel', 'model'),
));

$w = new sfWidgetFormChoice(array(
  'expanded' => true,
  'choices'  => array('published', 'draft', 'deleted'),
));

$w = new sfWidgetFormChoice(array(
  'expanded' => true,
  'multiple' => true,
  'choices'  => array('A week of symfony', 'Call the expert', 'Community'),
));

選択肢のグループ化

選択肢のグループ化は sfWidgetFormChoice ウィジェットによってサポートされ、choices オプションに入れ子の配列を渡すことで指定できます。

$choices = array(
  'Europe'  => array('France' => 'France', 'Spain' => 'Spain', 'Italy' => 'Italy'),
  'America' => array('USA' => 'USA', 'Canada' => 'Canada', 'Brazil' => 'Brazil'),
);
 
$w = new sfWidgetFormChoice(array('choices' => $choices));

expanded と multiple オプションも期待どおりに仕事をこなします。

$w = new sfWidgetFormChoice(array(
  'choices'  => $choices,
  'expanded' => true,
));

レンダラウィジェットに使われるレイアウトもカスタマイズできます。

$w = new sfWidgetFormChoice(array(
  'choices'  => $choices,
  'expanded' => true,
  'renderer_options' => array('template' => '<strong>%group%</strong> %options%'),
));

オプションの組み合わせの例は次のとおりです。

$w = new sfWidgetFormChoice(array(
  'choices'  => $choices,
  'multiple' => true,
));

$w = new sfWidgetFormChoice(array(
  'choices'  => $choices,
  'multiple' => true,
  'expanded' => true,
  'renderer_options' => array('template' => '<strong>%group%</strong> %options%'),
));

サポートされるオプション

ウィジェットによってサポートされているすべてのオプションのリストは次のとおりです。

sfWidgetFormSelectCheckbox と sfWidgetFormSelectRadio ウィジェットは次のオプションをサポートしています。

二重リストの表現

ユーザーが複数のオプションを選べるとき、別のボックスで選ばれたオプションを表示するほうがよい状況があります。

セレクトウィジェットを二重リストとしてレンダリングするために sfWidgetFormSelectDoubleList ウィジェットを使うことができます。

$w = new sfWidgetFormChoice(array(
  'choices'        => array('PHP', 'symfony', 'Doctrine', 'Propel', 'model'),
  'renderer_class' => 'sfWidgetFormSelectDoubleList',
));

$files = $w->getJavascripts();

自動入力補完

ユーザーがたくさんの選択肢のなかから要素を選べるようにしたい、これらすべての一覧をセンタボックスのなかで表示することが不可能になります。 sfWidgetFormJQueryAutocompleter はシンプルな input タグを自動入力セレクトボックスに変換することでこの問題を解決します。

$w = new sfWidgetFormChoice(array(
  'choices'          => array(),
  'renderer_class'   => 'sfWidgetFormJQueryAutocompleter',
  'renderer_options' => array('url' => '/autocomplete_script'),
));

url オプションはユーザーの入力にもとづいた選択肢を投入するためにウィジェットが呼び出す URL です。URL は2つのパラメータを受け入れます。

• q: ユーザーが入力した文字列
• limit: 返す項目の最大数

スクリプトは選択肢配列の有効な JSON 表記を返さなければなりません (配列を JSON に変換する PHP 標準関数の json_encode() を使います)。

選択肢が Propel のモデルに関連しているのであれば、sfWidgetFormPropelJQueryAutocompleter ウィジェットは外部キーの検索に合わせて最適化されます。

$w = new sfWidgetFormChoice(array(
  'renderer_class'   => 'sfWidgetFormPropelJQueryAutocompleter',
  'renderer_options' => array(
    'model' => 'Article',
    'url'   => '/autocomplete_script',
  ),
));

Propel モデルにバインドされる選択肢

選択肢が Propel モデルにバインドされる場合 (通常はユーザーによる外部キーの変更が許可されている場合)、 sfWidgetFormPropelChoice ウィジェットを使うことができます。

$w = new sfWidgetFormPropelChoice(array(
  'model'     => 'Article',
  'add_empty' => false,
));

あなたが渡した model クラスに従って choices はウィジェットによって自動的に読み出されます。専用のオプションセットを通じてウィジェットを細かく調整できます。

Doctrine モデルにバインドされる選択肢

選択肢が Doctrine モデルにバインドされる場合 (通常はユーザーによる外部キーの変更が許可されている場合)、 sfWidgetFormDoctrineChoice ウィジェットを使うことができます。

$w = new sfWidgetFormDoctrineChoice(array(
  'model'     => 'Article',
  'add_empty' => false,
));

渡した model クラスにしたがって、ウィジェットは choices を自動的に読み取ります。専用のオプションセットを通じてウィジェットの高度な調整が可能です。

日付ウィジェット

日付、時刻、もしくは日付と時刻に対して複数の select ボックスを提供することで、日付ウィジェットは日付の入力作業を簡略化します。symfony のすべての日付ウィジェットはいくつかの HTML タグによってあらわされます。これらはユーザーカルチャにしたがってカスタマイズすることも可能です。

sfWidgetFormDate

sfWidgetFormDate は日付ウィジェットをあらわします。

ユーザーによって投稿された値はウィジェットの名前の配列に保存されます。

$w = new sfWidgetFormDate();
$w->render('date');
 
# 投稿された値は `date` 配列になります
# array(
#   'date' => array(
#     'day'   => 15,
#     'month' => 10,
#     'year'  => 2005,
#   ),
# );

ウィジェットのふるまいはさまざまなオプションでカスタマイズできます。

format オプションを使って、デフォルトタグの並びをカスタマイズできます (render() メソッドが呼び出されるとき、%year%、%month% と %day% プレースホルダは対応する select タグに置き換えられます)。

$w = new sfWidgetFormDate(
  array('format' => '%year% - %month% - %day%')
);

デフォルトでは、現在の年から10年前後の年の select タグが投入されます。 これは years オプションを使って変更できます。

$years = range(2009, 2020);
$w = new sfWidgetFormDate(
  array('years' => array_combine($years, $years))
);

years、months と days オプションは配列を受け入れます。キーは option タグの値で値はユーザーに表示される文字列です。

sfWidgetFormTime

sfWidgetFormTime は時刻ウィジェットをあらわします。

ユーザーによって投稿された値はウィジェットの名前の配列に保存されます。

$w = new sfWidgetFormTime();
$w->render('time');
 
# 投稿された値は配列 time になります
# array(
#   'time' => array(
#     'hour'    => 12,
#     'minute'  => 13,
#     'second'  => 14,
#   ),
# );

ウィジェットのふるまいは多くのオプションでカスタマイズできます。

デフォルトでは、ウィジェットは秒の選択肢を許可しません。with_seconds オプションに true をセットすることで変更できます。

$w = new sfWidgetFormTime(array('with_seconds' => true));

format オプションと format_without_seconds オプションを使うことでデフォルトタグの並びをカスタマイズできます (render() メソッドが呼び出されるとき %hour%、%minute% と %second% プレースホルダは対応する select タグに置き換えられます)。

$w = new sfWidgetFormTime(array(
  'with_seconds' => true,
  'format'       => '%hour% : %minute% : %second%',
));

すべての分もしくは秒を表示したくなければ、3つのタグそれぞれに対して独自の値を提供できます。

$seconds = array(0, 15, 30, 45);
$w = new sfWidgetFormTime(array(
  'with_seconds' => true,
  'seconds'      => array_combine($seconds, $seconds),
));

hours、minutes と seconds オプションは配列を受け入れます。キーは option タグの配列で値はユーザーに表示される文字列です。

sfWidgetFormDateTime

sfWidgetFormDateTime ウィジェットは2つのサブウィジェット: sfWidgetFormDate ウィジェットと sfWidgetFormTime ウィジェットをレンダリングするウィジェットです。

$w = new sfWidgetFormDateTime();

sfWidgetFormI18nDate

sfWidgetFormI18nDate は標準の sfWidgetFormDate ウィジェットを拡張します。標準ウィジェットが月を数字として表示するのに対して、国際化対応ウィジェットはカルチャにしたがってこれらをローカライズされた文字列として表示します。

$w = new sfWidgetFormI18nDate(array('culture' => 'fr'));

月の文字列のフォーマットは month_format オプションで調整できます。 このウィジェットは3つの値: name (デフォルト)、short_name と number を受け入れます。

$w = new sfWidgetFormI18nDate(array(
  'culture'      => 'fr',
  'month_format' => 'short_name',
));

カルチャにしたがって、ウィジェットは3つの異なる select ボックスの順序とそれらのあいだで使う区切り文字を理解します。

sfWidgetFormI18nTime

sfWidgetFormI18nTime は標準の sfWidgetFormTime ウィジェットを拡張します。

オプションとして渡されるユーザーカルチャにしたがって、ウィジェットは3つの異なる select ボックスとそれらのあいだで使われる区切り文字を理解します。

$w = new sfWidgetFormI18nTime(array('culture' => 'ar'));

sfWidgetFormI18nDateTime

sfWidgetFormI18nDateTime は2つのサブウィジェット: sfWidgetFormI18nDate ウィジェットと sfWidgetFormI18nTime ウィジェットをレンダリングするウィジェットです。

sfWidgetFormDateRange

sfWidgetFormDateRange ウィジェットは日付範囲の選択肢をあらわします。

$w = new sfWidgetFormDateRange(array(
  'from_date' => new sfWidgetFormDate(),
  'to_date'   => new sfWidgetFormDate(),
));

ウィジェットをレンダリングするために使われるテンプレートは template オプションでカスタマイズできます。

$w = new sfWidgetFormDateRange(array(
  'from_date' => new sfWidgetFormDate(),
  'to_date'   => new sfWidgetFormDate(),
  'template'  => 'Begin at: %from_date%<br />End at: %to_date%',
));

sfWidgetFormJQueryDate

sfWidgetFormJQueryDate は jQuery UI でレンダリングされる日付ウィジェットをあらわします。

$w = new sfWidgetFormJQueryDate(array(
  'culture' => 'en',
));

国際化ウィジェット

sfWidgetFormI18nChoiceCountry

sfWidgetFormI18nChoiceCountry ウィジェットは国コードの選択肢をあらわします。

$w = new sfWidgetFormI18nChoiceCountry(array('culture' => 'fr'));

sfWidgetFormI18nChoiceLanguage

sfWidgetFormI18nChoiceLanguage は言語コードの選択肢をあらわします。

$w = new sfWidgetFormI18nChoiceLanguage(array('culture' => 'fr'));

sfWidgetFormI18nChoiceCurrency

sfWidgetFormI18nChoiceCurrency は通貨コードの選択肢をあらわします。

$w = new sfWidgetFormI18nChoiceCurrency(array('culture' => 'fr'));

sfWidgetFormI18nChoiceTimezone

sfWidgetFormI18nChoiceTimezone はタイムゾーンの選択肢をあらわします。

$w = new sfWidgetFormI18nChoiceTimezone(array('culture' => 'fr'));

Captcha ウィジェット

sfFormExtraPluginプラグインには ReCaptcha プロジェクト をベースとするキャプチャウィジェットの sfWidgetFormReCaptcha が搭載されています。

$w = new sfWidgetFormReCaptcha(array(
  'public_key' => 'RECAPTCHA_PUBLIC_KEY'
));

public_key オプションは ReCaptcha の公開鍵です。 API のキーは無料で入手できます。

ReCaptcha フィールドの名前を変更することはできないので、HTTP リクエストからフォームをバインドするとき、これらを手動で追加しなければなりません。

たとえば、フォームが contact[%s] ネームフォーマットをもっている場合、キャプチャ情報が残りのフォームに投稿された値にマージされることを保証するために必要なコードは次のとおりです。

$captcha = array(
  'recaptcha_challenge_field' => $request->getParameter('recaptcha_challenge_field'),
  'recaptcha_response_field'  => $request->getParameter('recaptcha_response_field'),
);
$submittedValues = array_merge(
  $request->getParameter('contact'),
  array('captcha' => $captcha)
);

このウィジェットは sfValidatorReCatpcha バリデータと一緒に使われます。

フィルタウィジェット

フィルタウィジェットは特別なウィジェットで、フィルタとしてふるまうフォームをレンダリングするために使うことができます。

sfWidgetFormFilterInput

sfWidgetFormFilterInput はテキストのフィルタをあらわします。 デフォルトでは、ユーザーが空のテキストを検索できるようにするチェックボックスがこのウィジェットに含まれています。

sfWidgetFormFilterDate

sfWidgetFormFilterDate は日付の範囲をフィリタリングするウィジェットをあらわします。デフォルトでは、ユーザーが空の日付を検索できるようにするチェックボックスがこのウィジェットに含まれます。

sfWidgetFormSchema

sfWidgetFormSchema ウィジェットはいくつかのフィールドで構成されるウィジェットをあらわします。フィールドは名前つきのシンプルなウィジェットです。

$w = new sfWidgetFormSchema(array(
  'name'    => new sfWidgetFormInputText(),
  'country' => new sfWidgetFormI18nChoiceCountry(),
));

sfWidgetFormSchema コンストラクタは5つのオプション引数をとります。

• フィールドの配列
• オプションの配列
• HTML 属性の配列
• 埋め込みウィジェットのラベルの配列
• 埋め込みウィジェットのヘルプメッセージの配列

利用可能なオプションは次のとおりです。

すべてのフォームに対してデフォルトのフォーマッタを変更したい場合、setDefaultFormFormatterName() メソッドを呼び出します。

sfWidgetFormSchema::setDefaultFormFormatterName('list');

sfWidgetFormSchema クラスは sfWidgetForm クラスを継承するので、すべてのメソッドとふるまいを継承します。

<Table>
  <?php echo $ws->render('') ?>
</table>

埋め込みのウィジェットにアクセスするために sfWidgetFormSchema を配列として使うことができます。

$ws = new sfWidgetFormSchema(array('name' => new sfWidgetFormInputText()));
 
$nameWidget = $ws['name'];
 
unset($ws['name']);

ほかのスキーマのように、ウィジェットスキーマをネストにできます。

$ws = new sfWidgetFormSchema(array(
  'title'  => new sfWidgetFormInputText(),
  'author' => new sfWidgetFormSchema(array(
    'first_name' => new sfWidgetFormInputText(),
    'last_name'  => new sfWidgetFormInputText(),
  )),
));

埋め込みのウィジェットスキーマに配列記法でアクセスできます。

$ws['author']['first_name']->setLabel('First Name');

次の節において、ウィジェットスキーマクラスのメインメソッドが説明されていますが、すべてのメソッドのリストに関して、オンラインの API ドキュメントをご参照ください。

setLabel()、getLabel()、setLabels()、getLabels()

setLabel()、getLabel()、setLabels() と getLabels() メソッドは埋め込みウィジェットのラベルを管理します。 これらはウィジェットの getLabel() と setLabel() メソッドのプロキシメソッドです。

$ws = new sfWidgetFormSchema(array('name' => new sfWidgetFormInputText()));
 
$ws->setLabel('name', 'Fabien');
 
// 上記のコードは下記のコードと同等です
 
$ws['name']->setLabel('Fabien');
 
// もしくは
 
$ws->setLabels(array('name' => 'Fabien'));

setLabels() メソッドは渡された値を既存の値にマージします。

setDefault()、getDefault()、setDefaults()、getDefaults()

setDefault()、getDefault()、setDefaults() と getDefaults() メソッドは埋め込みウィジェットのデフォルト値を管理します。 これらはウィジェットの getDefault() と setDefault() メソッドのプロキシメソッドです。

$ws = new sfWidgetFormSchema(array('name' => new sfWidgetFormInputText()));
 
$ws->setDefault('name', 'Fabien');
 
// 上記のコードは下記のコードと同等です
 
$ws['name']->setDefault('Fabien');
 
// もしくは
 
$ws->setDefaults(array('name' => 'Fabien'));

setDefaults() メソッドは渡された値を既存の値にマージします。

setHelp()、setHelps()、getHelps()、getHelp()

setHelp()、setHelps()、getHelps() getHelp() メソッドは埋め込みウィジェットに関連したヘルプメッセージを管理します。

$ws = new sfWidgetFormSchema(array('name' => new sfWidgetFormInputText()));
 
$ws->setHelp('name', 'Fabien');
 
// 上記のコードは下記のコードと同等です
 
$ws->setHelps(array('name' => 'Fabien'));

setHelps() メソッドは受け取った値を既存の値にマージします。

getPositions()、setPositions()、moveField()

ウィジェットスキーマに含まれるフィールドの並べ替えが行われます。 順番は moveField() メソッドで変更できます。

$ws = new sfWidgetFormSchema(array(
  'first_name' => new sfWidgetFormInputText(),
  'last_name' => new sfWidgetFormInputText()
));
 
$ws->moveField('first_name', sfWidgetFormSchema::AFTER, 'last_name');

定数は次のとおりです。

• sfWidgetFormSchema::FIRST
• sfWidgetFormSchema::LAST
• sfWidgetFormSchema::BEFORE
• sfWidgetFormSchema::AFTER

setPositions() メソッドですべての位置を変更することも可能です。

$ws->setPositions(array('last_name', 'first_name'));

sfWidgetFormSchemaDecorator

sfWidgetFormSchemaDecorator ウィジェットは任意の HTML スニペット内部のフォームスキーマウィジェットをラッピングするプロキシウィジェットスキーマです。

$ws = new sfWidgetFormSchema(array('name' => new sfWidgetFormInputText()));
 
$wd = new sfWidgetFormSchemaDecorator($ws, '<table>%content%</table>');