Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

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

Size:1550
Storage flags:no_autoload,compress/gzip (46%)

:orphan:

.. _zend.form.element.url:

Url
^^^

``Zend\Form\Element\Url`` is meant to be paired with the ``Zend\Form\View\Helper\FormUrl`` for `HTML5 inputs with type
url`_. This element adds filters and a ``Zend\Validator\Uri`` validator to it's input filter specification for
validating HTML5 URL input values on the server.

.. _zend.form.element.url.usage:

.. rubric:: Basic Usage

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

.. code-block:: php
   :linenos:

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

   $url = new Element\Url('webpage-url');
   $url->setLabel('Webpage URL');

   $form = new Form('my-form');
   $form->add($url);
   
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\Url',
    	'name' => 'webpage-url',
    	'options' => array(
    		'label' => 'Webpage URL'
    	)
    ));

.. _zend.form.element.url.methods:

.. rubric:: Public Methods

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

.. function:: getInputSpecification()
   :noindex:

   Returns a input filter specification, which includes a ``Zend\Filter\StringTrim`` filter, and a
   ``Zend\Validator\Uri`` to validate the URI string.

   :rtype: array



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

For more information about the PHK package format: http://phk.tekwire.net