interface/modules/zend_modules/library/Zend/Form/Element/MultiCheckbox.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\Element;
  11
  12 use Zend\Form\ElementInterface;
  13 use Zend\Form\Exception\InvalidArgumentException;
  14 use Zend\Validator\Explode as ExplodeValidator;
  15 use Zend\Validator\InArray as InArrayValidator;
  16 use Zend\Validator\ValidatorInterface;
  17
  18 class MultiCheckbox extends Checkbox
  19 {
  20     /**
  21      * Seed attributes
  22      *
  23      * @var array
  24      */
  25     protected $attributes = array(
  26         'type' => 'multi_checkbox',
  27     );
  28
  29     /**
  30      * @var bool
  31      */
  32     protected $useHiddenElement = false;
  33
  34     /**
  35      * @var string
  36      */
  37     protected $uncheckedValue = '';
  38
  39     /**
  40      * @var array
  41      */
  42     protected $valueOptions = array();
  43
  44     /**
  45      * @return array
  46      */
  47     public function getValueOptions()
  48     {
  49         return $this->valueOptions;
  50     }
  51
  52     /**
  53      * @param  array $options
  54      * @return MultiCheckbox
  55      */
  56     public function setValueOptions(array $options)
  57     {
  58         $this->valueOptions = $options;
  59
  60         // Update Explode validator haystack
  61         if ($this->validator instanceof ExplodeValidator) {
  62             $validator = $this->validator->getValidator();
  63             $validator->setHaystack($this->getValueOptionsValues());
  64         }
  65
  66         return $this;
  67     }
  68
  69     /**
  70      * Set options for an element. Accepted options are:
  71      * - label: label to associate with the element
  72      * - label_attributes: attributes to use when the label is rendered
  73      * - value_options: list of values and labels for the select options
  74      *
  75      * @param  array|\Traversable $options
  76      * @return MultiCheckbox|ElementInterface
  77      * @throws InvalidArgumentException
  78      */
  79     public function setOptions($options)
  80     {
  81         parent::setOptions($options);
  82
  83         if (isset($this->options['value_options'])) {
  84             $this->setValueOptions($this->options['value_options']);
  85         }
  86         // Alias for 'value_options'
  87         if (isset($this->options['options'])) {
  88             $this->setValueOptions($this->options['options']);
  89         }
  90
  91         return $this;
  92     }
  93
  94     /**
  95      * Set a single element attribute
  96      *
  97      * @param  string $key
  98      * @param  mixed  $value
  99      * @return MultiCheckbox|ElementInterface
 100      */
 101     public function setAttribute($key, $value)
 102     {
 103         // Do not include the options in the list of attributes
 104         // TODO: Deprecate this
 105         if ($key === 'options') {
 106             $this->setValueOptions($value);
 107             return $this;
 108         }
 109         return parent::setAttribute($key, $value);
 110     }
 111
 112     /**
 113      * Get validator
 114      *
 115      * @return ValidatorInterface
 116      */
 117     protected function getValidator()
 118     {
 119         if (null === $this->validator) {
 120             $inArrayValidator = new InArrayValidator(array(
 121                 'haystack'  => $this->getValueOptionsValues(),
 122                 'strict'    => false,
 123             ));
 124             $this->validator = new ExplodeValidator(array(
 125                 'validator'      => $inArrayValidator,
 126                 'valueDelimiter' => null, // skip explode if only one value
 127             ));
 128         }
 129         return $this->validator;
 130     }
 131
 132     /**
 133      * Get only the values from the options attribute
 134      *
 135      * @return array
 136      */
 137     protected function getValueOptionsValues()
 138     {
 139         $values = array();
 140         $options = $this->getValueOptions();
 141         foreach ($options as $key => $optionSpec) {
 142             $value = (is_array($optionSpec)) ? $optionSpec['value'] : $key;
 143             $values[] = $value;
 144         }
 145         if ($this->useHiddenElement()) {
 146             $values[] = $this->getUncheckedValue();
 147         }
 148         return $values;
 149     }
 150
 151     /**
 152      * Sets the value that should be selected.
 153      *
 154      * @param mixed $value The value to set.
 155      * @return MultiCheckbox
 156      */
 157     public function setValue($value)
 158     {
 159         $this->value = $value;
 160         return $this;
 161     }
 162 }