Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

169 lines (151 sloc) 4.298 kb
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Form
*/
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;
/**
* @category Zend
* @package Zend_Form
* @subpackage Element
*/
class MultiCheckbox extends Checkbox
{
/**
* Seed attributes
*
* @var array
*/
protected $attributes = array(
'type' => 'multi_checkbox',
);
/**
* @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 InArray validator haystack
if (!is_null($this->validator)) {
$validator = $this->validator->getValidator();
$validator->setHaystack($this->getValueOptionsValues());
}
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']);
}
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);
}
/**
* Get validator
*
* @return ValidatorInterface
*/
protected function getValidator()
{
if (null === $this->validator) {
$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;
}
}
Jump to Line
Something went wrong with that request. Please try again.