Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
247 lines (220 sloc) 6.65 KB
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Form
* @subpackage Element
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Form\Element;
use Traversable;
use Zend\Form\Element;
use Zend\Form\ElementInterface;
use Zend\Form\Exception\InvalidArgumentException;
use Zend\InputFilter\InputProviderInterface;
use Zend\Validator\Explode as ExplodeValidator;
use Zend\Validator\InArray as InArrayValidator;
use Zend\Validator\ValidatorInterface;
/**
* @category Zend
* @package Zend_Form
* @subpackage Element
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Select extends Element implements InputProviderInterface
{
/**
* Seed attributes
*
* @var array
*/
protected $attributes = array(
'type' => 'select',
);
/**
* @var ValidatorInterface
*/
protected $validator;
/**
* Create an empty option (option with label but no value). If set to null, no option is created
*
* @var bool
*/
protected $emptyOption = null;
/**
* @var array
*/
protected $valueOptions = array();
/**
* @return array
*/
public function getValueOptions()
{
return $this->valueOptions;
}
/**
* @param array $options
* @return Select
*/
public function setValueOptions(array $options)
{
$this->valueOptions = $options;
// Update InArrayValidator validator haystack
if (!is_null($this->validator)) {
if ($this->validator instanceof InArrayValidator){
$validator = $this->validator;
}
if ($this->validator instanceof ExplodeValidator
&& $this->validator->getValidator() instanceof InArrayValidator
){
$validator = $this->validator->getValidator();
}
if (!empty($validator)){
$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
* _ empty_option: should an empty option be prepended to the options ?
*
* @param array|\Traversable $options
* @return Select|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['empty_option'])) {
$this->setEmptyOption($this->options['empty_option']);
}
return $this;
}
/**
* Set a single element attribute
*
* @param string $key
* @param mixed $value
* @return Select|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 string for an empty option (can be empty string). If set to null, no option will be added
*
* @param string|null $emptyOption
* @return Select
*/
public function setEmptyOption($emptyOption)
{
$this->emptyOption = $emptyOption;
return $this;
}
/**
* Return the string for the empty option (null if none)
*
* @return string|null
*/
public function getEmptyOption()
{
return $this->emptyOption;
}
/**
* Get validator
*
* @return ValidatorInterface
*/
protected function getValidator()
{
if (null === $this->validator) {
$validator = new InArrayValidator(array(
'haystack' => $this->getValueOptionsValues(),
'strict' => false
));
$multiple = (isset($this->attributes['multiple']))
? $this->attributes['multiple'] : null;
if (true === $multiple || 'multiple' === $multiple) {
$validator = new ExplodeValidator(array(
'validator' => $validator,
'valueDelimiter' => null, // skip explode if only one value
));
}
$this->validator = $validator;
}
return $this->validator;
}
/**
* Provide default input rules for this element
*
* Attaches the captcha as a validator.
*
* @return array
*/
public function getInputSpecification()
{
$spec = array(
'name' => $this->getName(),
'required' => true,
'validators' => array(
$this->getValidator()
)
);
return $spec;
}
/**
* Get only the values from the options attribute
*
* @return array
*/
protected function getValueOptionsValues()
{
$values = array();
$options = $this->getValueOptions();
foreach ($options as $key => $optionSpec) {
if (is_array($optionSpec) && array_key_exists('options', $optionSpec)) {
foreach ($optionSpec['options'] as $nestedKey => $nestedOptionSpec) {
$values[] = $this->getOptionValue($nestedKey, $nestedOptionSpec);
}
continue;
}
$values[] = $this->getOptionValue($key, $optionSpec);
}
return $values;
}
protected function getOptionValue($key, $optionSpec)
{
return is_array($optionSpec) ? $optionSpec['value'] : $key;
}
}
Jump to Line
Something went wrong with that request. Please try again.