Home Info Files

Zend Framework 2 Documentation (Manual)

File: /_sources/modules/zend.form.element.time.txt

:orphan:

.. _zend.form.element.time:

Time
^^^^

``Zend\Form\Element\Time`` is meant to be paired with the ``Zend\Form\View\Helper\FormTime`` for `HTML5 inputs with type
time`_. This element adds filters and validators to it's input filter specification in order to validate HTML5 time
input values on the server.

.. _zend.form.element.time.usage:

.. rubric:: Basic Usage

This element automatically adds a ``"type"`` attribute of value ``"time"``.

.. code-block:: php
   :linenos:

   use Zend\Form\Element;
   use Zend\Form\Form;

   $time = new Element\Time('time');
   $time
       ->setLabel('Time')
       ->setAttributes(array(
           'min'  => '00:00:00',
           'max'  => '23:59:59',
           'step' => '60', // seconds; default step interval is 60 seconds
       ))
       ->setOptions(array(
           'format' => 'H:i:s'
       ));

   $form = new Form('my-form');
   $form->add($time);

Here is the same example using the array notation:

.. code-block:: php
   :linenos:

    use Zend\Form\Form;

    $form = new Form('my-form');
    $form->add(array(
    	'type' => 'Zend\Form\Element\Time',
    	'name' => 'time',
    	'options'=> array(
    		'label'  => 'Time',
    		'format' => 'H:i:s'
    	),
    	'attributes' => array(
    		'min' => '00:00:00',
    		'max' => '23:59:59',
    		'step' => '60', // seconds; default step interval is 60 seconds
    	)
    ));

.. note::

   The ``min``, ``max``, and ``step`` attributes should be set prior to calling Zend\\Form::prepare().
   Otherwise, the default input specification for the element may not contain the correct validation rules.

.. note::

   The default date format for the validator is ``H:i:s``. A valid time string is however not required to have a
   seconds part. In fact some user agent UIs such as Google Chrome and Opera submits a value on the ``H:i`` format (i.e.
   without a second part). You might therefore want to set the date format accordingly.

.. _zend.form.element.time.methods:

.. rubric:: Public Methods

The following methods are in addition to the inherited :ref:`methods of Zend\\Form\\Element\\DateTime
<zend.form.element.date-time.methods>`.

.. function:: getInputSpecification()
   :noindex:

   Returns a input filter specification, which includes ``Zend\Filter\StringTrim`` and will add the appropriate
   validators based on the values from the ``min``, ``max``, and ``step`` attributes and ``format`` option. See
   :ref:`getInputSpecification in Zend\\Form\\Element\\DateTime
   <zend.form.element.date-time.methods.get-input-specification>` for more information.

   One difference from ``Zend\Form\Element\DateTime`` is that the ``Zend\Validator\DateStep`` validator will expect
   the ``step`` attribute to use an interval of seconds (default is 60 seconds).

   :rtype: array



.. _`HTML5 inputs with type time`: http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#time-state-(type=time)