Source of file MultiCheckbox.php
Size: 5,261 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Form/Element/MultiCheckbox.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Form\Element; use Zend\Form\ElementInterface; use Zend\Form\Exception\InvalidArgumentException; use Zend\Validator\Explode as ExplodeValidator; use Zend\Validator\InArray as InArrayValidator; use Zend\Validator\ValidatorInterface; class MultiCheckbox extends Checkbox { /** * Seed attributes * * @var array */ protected $attributes = array( 'type' => 'multi_checkbox', ); /** * @var bool */ protected $disableInArrayValidator = false; /** * @var bool */ protected $useHiddenElement = false; /** * @var string */ protected $uncheckedValue = ''; /** * @var array */ protected $valueOptions = array(); /** * @return array */ public function getValueOptions() { return $this->valueOptions; } /** * @param array $options * @return MultiCheckbox */ public function setValueOptions(array $options) { $this->valueOptions = $options; // Update Explode validator haystack if ($this->validator instanceof ExplodeValidator) { $validator = $this->validator->getValidator(); $validator->setHaystack($this->getValueOptionsValues()); } return $this; } /** * @param string $key * @return self */ public function unsetValueOption($key) { if (isset($this->valueOptions[$key])) { unset($this->valueOptions[$key]); } return $this; } /** * Set options for an element. Accepted options are: * - label: label to associate with the element * - label_attributes: attributes to use when the label is rendered * - value_options: list of values and labels for the select options * * @param array|\Traversable $options * @return MultiCheckbox|ElementInterface * @throws InvalidArgumentException */ public function setOptions($options) { parent::setOptions($options); if (isset($this->options['value_options'])) { $this->setValueOptions($this->options['value_options']); } // Alias for 'value_options' if (isset($this->options['options'])) { $this->setValueOptions($this->options['options']); } if (isset($this->options['disable_inarray_validator'])) { $this->setDisableInArrayValidator($this->options['disable_inarray_validator']); } return $this; } /** * Set a single element attribute * * @param string $key * @param mixed $value * @return MultiCheckbox|ElementInterface */ public function setAttribute($key, $value) { // Do not include the options in the list of attributes // TODO: Deprecate this if ($key === 'options') { $this->setValueOptions($value); return $this; } return parent::setAttribute($key, $value); } /** * Set the flag to allow for disabling the automatic addition of an InArray validator. * * @param bool $disableOption * @return Select */ public function setDisableInArrayValidator($disableOption) { $this->disableInArrayValidator = (bool) $disableOption; return $this; } /** * Get the disable in array validator flag. * * @return bool */ public function disableInArrayValidator() { return $this->disableInArrayValidator; } /** * Get validator * * @return ValidatorInterface */ protected function getValidator() { if (null === $this->validator && !$this->disableInArrayValidator()) { $inArrayValidator = new InArrayValidator(array( 'haystack' => $this->getValueOptionsValues(), 'strict' => false, )); $this->validator = new ExplodeValidator(array( 'validator' => $inArrayValidator, 'valueDelimiter' => null, // skip explode if only one value )); } return $this->validator; } /** * Get only the values from the options attribute * * @return array */ protected function getValueOptionsValues() { $values = array(); $options = $this->getValueOptions(); foreach ($options as $key => $optionSpec) { $value = (is_array($optionSpec)) ? $optionSpec['value'] : $key; $values[] = $value; } if ($this->useHiddenElement()) { $values[] = $this->getUncheckedValue(); } return $values; } /** * Sets the value that should be selected. * * @param mixed $value The value to set. * @return MultiCheckbox */ public function setValue($value) { $this->value = $value; return $this; } } |