interface/modules/zend_modules/library/Zend/Form/View/Helper/FormButton.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Form\View\Helper;
  11
  12 use Zend\Form\ElementInterface;
  13 use Zend\Form\Exception;
  14
  15 class FormButton extends FormInput
  16 {
  17     /**
  18      * Attributes valid for the button tag
  19      *
  20      * @var array
  21      */
  22     protected $validTagAttributes = array(
  23         'name'           => true,
  24         'autofocus'      => true,
  25         'disabled'       => true,
  26         'form'           => true,
  27         'formaction'     => true,
  28         'formenctype'    => true,
  29         'formmethod'     => true,
  30         'formnovalidate' => true,
  31         'formtarget'     => true,
  32         'type'           => true,
  33         'value'          => true,
  34     );
  35
  36     /**
  37      * Valid values for the button type
  38      *
  39      * @var array
  40      */
  41     protected $validTypes = array(
  42         'button'         => true,
  43         'reset'          => true,
  44         'submit'         => true,
  45     );
  46
  47     /**
  48      * Invoke helper as functor
  49      *
  50      * Proxies to {@link render()}.
  51      *
  52      * @param  ElementInterface|null $element
  53      * @param  null|string           $buttonContent
  54      * @return string|FormButton
  55      */
  56     public function __invoke(ElementInterface $element = null, $buttonContent = null)
  57     {
  58         if (!$element) {
  59             return $this;
  60         }
  61
  62         return $this->render($element, $buttonContent);
  63     }
  64
  65     /**
  66      * Render a form <button> element from the provided $element,
  67      * using content from $buttonContent or the element's "label" attribute
  68      *
  69      * @param  ElementInterface $element
  70      * @param  null|string $buttonContent
  71      * @throws Exception\DomainException
  72      * @return string
  73      */
  74     public function render(ElementInterface $element, $buttonContent = null)
  75     {
  76         $openTag = $this->openTag($element);
  77
  78         if (null === $buttonContent) {
  79             $buttonContent = $element->getLabel();
  80             if (null === $buttonContent) {
  81                 throw new Exception\DomainException(sprintf(
  82                     '%s expects either button content as the second argument, ' .
  83                         'or that the element provided has a label value; neither found',
  84                     __METHOD__
  85                 ));
  86             }
  87
  88             if (null !== ($translator = $this->getTranslator())) {
  89                 $buttonContent = $translator->translate(
  90                     $buttonContent, $this->getTranslatorTextDomain()
  91                 );
  92             }
  93         }
  94
  95         $escape = $this->getEscapeHtmlHelper();
  96
  97         return $openTag . $escape($buttonContent) . $this->closeTag();
  98     }
  99
 100     /**
 101      * Generate an opening button tag
 102      *
 103      * @param  null|array|ElementInterface $attributesOrElement
 104      * @throws Exception\InvalidArgumentException
 105      * @throws Exception\DomainException
 106      * @return string
 107      */
 108     public function openTag($attributesOrElement = null)
 109     {
 110         if (null === $attributesOrElement) {
 111             return '<button>';
 112         }
 113
 114         if (is_array($attributesOrElement)) {
 115             $attributes = $this->createAttributesString($attributesOrElement);
 116             return sprintf('<button %s>', $attributes);
 117         }
 118
 119         if (!$attributesOrElement instanceof ElementInterface) {
 120             throw new Exception\InvalidArgumentException(sprintf(
 121                 '%s expects an array or Zend\Form\ElementInterface instance; received "%s"',
 122                 __METHOD__,
 123                 (is_object($attributesOrElement) ? get_class($attributesOrElement) : gettype($attributesOrElement))
 124             ));
 125         }
 126
 127         $element = $attributesOrElement;
 128         $name    = $element->getName();
 129         if (empty($name) && $name !== 0) {
 130             throw new Exception\DomainException(sprintf(
 131                 '%s requires that the element has an assigned name; none discovered',
 132                 __METHOD__
 133             ));
 134         }
 135
 136         $attributes          = $element->getAttributes();
 137         $attributes['name']  = $name;
 138         $attributes['type']  = $this->getType($element);
 139         $attributes['value'] = $element->getValue();
 140
 141         return sprintf(
 142             '<button %s>',
 143             $this->createAttributesString($attributes)
 144         );
 145     }
 146
 147     /**
 148      * Return a closing button tag
 149      *
 150      * @return string
 151      */
 152     public function closeTag()
 153     {
 154         return '</button>';
 155     }
 156
 157     /**
 158      * Determine button type to use
 159      *
 160      * @param  ElementInterface $element
 161      * @return string
 162      */
 163     protected function getType(ElementInterface $element)
 164     {
 165         $type = $element->getAttribute('type');
 166         if (empty($type)) {
 167             return 'submit';
 168         }
 169
 170         $type = strtolower($type);
 171         if (!isset($this->validTypes[$type])) {
 172             return 'submit';
 173         }
 174
 175         return $type;
 176     }
 177 }