Skip to content
Browse files

Restore select doc

  • Loading branch information...
1 parent 3a115f8 commit d291b93ad3d2b0ce54ae821661c52532cd7492f5 @bakura10 committed Oct 4, 2012
Showing with 66 additions and 37 deletions.
  1. +66 −37 docs/languages/en/modules/zend.form.element.select.rst
View
103 docs/languages/en/modules/zend.form.element.select.rst
@@ -21,6 +21,71 @@ This element automatically adds a ``"type"`` attribute of value ``"select"``.
$select = new Element\Select('language');
$select->setLabel('Which is your mother tongue?');
$select->setValueOptions(array(
+ '0' => 'French',
+ '1' => 'English',
+ '2' => 'Japanese',
+ '3' => 'Chinese',
+ ));
+
+ $form = new Form('language');
+ $form->add($select);
+
+Using the array notation:
+
+.. code-block:: php
+ :linenos:
+
+ use Zend\Form\Form;
+
+ $form = new Form('my-form');
+ $form->add(array(
+ 'type' => 'Zend\Form\Element\Select',
+ 'name' => 'language'
+ 'options' => array(
+ 'label' => 'Which is your mother tongue?',
+ 'value_options' => array(
+ '0' => 'French',
+ '1' => 'English',
+ '2' => 'Japanese',
+ '3' => 'Chinese',
+ ),
+ )
+ ));
+
+You can add an empty option (option with no value) using the ``"empty_option"`` option:
+
+.. code-block:: php
+ :linenos:
+
+ use Zend\Form\Form;
+
+ $form = new Form('my-form');
+ $form->add(array(
+ 'type' => 'Zend\Form\Element\Select',
+ 'name' => 'language'
+ 'options' => array(
+ 'label' => 'Which is your mother tongue?',
+ 'empty_option' => 'Please choose your language',
+ 'value_options' => array(
+ '0' => 'French',
+ '1' => 'English',
+ '2' => 'Japanese',
+ '3' => 'Chinese',
+ ),
+ )
+ ));
+
+Option groups are also supported. You just need to add an 'options' key to the value options.
+
+.. code-block:: php
+ :linenos:
+
+ use Zend\Form\Element;
+ use Zend\Form\Form;
+
+ $select = new Element\Select('language');
+ $select->setLabel('Which is your mother tongue?');
+ $select->setValueOptions(array(
'options' => array(
'European languages' => array(
'0' => 'French',
@@ -70,40 +135,4 @@ The following methods are in addition to the inherited :ref:`methods of Zend\\Fo
Get the label for the empty option (null if none).
- :rtype: string
-
-.. _zend.form.element.select.methods:
-
-Public Methods
-""""""""""""""
-
-The following methods are in addition to the inherited :ref:`methods of Zend\\Form\\Element <zend.form.element.methods>` .
-
-.. function:: setOptions(array $options)
- :noindex:
-
- Set options for an element of type Checkbox. Accepted options, in addition to the inherited options of Zend\\Form\\Element\\Checkbox <zend.form.element.checkbox.methods.set-options>` , are: ``"value_options"`` and ``"empty_option"``, which call ``setValueOptions`` and ``setEmptyOption``, respectively.
-
-.. function:: setValueOptions(array $options)
- :noindex:
-
- Set the value options for every checkbox of the multi-checkbox. The array must contain a key => value for every checkbox.
-
-.. function:: getValueOptions()
- :noindex:
-
- Return the value options.
-
- :rtype: array
-
-.. function:: setEmptyOption($emptyOption)
- :noindex:
-
- Optionally set a label for an empty option (option with no value). It is set to "null" by default, which means that no empty option will be rendered.
-
-.. function:: setEmptyOption()
- :noindex:
-
- Get the label for the empty option (null if none).
-
- :rtype: string
+ :rtype: string

0 comments on commit d291b93

Please sign in to comment.
Something went wrong with that request. Please try again.