vendor/zendframework/zend-form/src/Element/Checkbox.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-2015 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 Traversable;
  13 use Zend\Form\Element;
  14 use Zend\InputFilter\InputProviderInterface;
  15 use Zend\Validator\InArray as InArrayValidator;
  16
  17 class Checkbox extends Element implements InputProviderInterface
  18 {
  19     /**
  20      * Seed attributes
  21      *
  22      * @var array
  23      */
  24     protected $attributes = [
  25         'type' => 'checkbox'
  26     ];
  27
  28     /**
  29      * @var \Zend\Validator\ValidatorInterface
  30      */
  31     protected $validator;
  32
  33     /**
  34      * @var bool
  35      */
  36     protected $useHiddenElement = true;
  37
  38     /**
  39      * @var string
  40      */
  41     protected $uncheckedValue = '0';
  42
  43     /**
  44      * @var string
  45      */
  46     protected $checkedValue = '1';
  47
  48     /**
  49      * Accepted options for MultiCheckbox:
  50      * - use_hidden_element: do we render hidden element?
  51      * - unchecked_value: value for checkbox when unchecked
  52      * - checked_value: value for checkbox when checked
  53      *
  54      * @param  array|Traversable $options
  55      * @return Checkbox
  56      */
  57     public function setOptions($options)
  58     {
  59         parent::setOptions($options);
  60
  61         if (isset($options['use_hidden_element'])) {
  62             $this->setUseHiddenElement($options['use_hidden_element']);
  63         }
  64
  65         if (isset($options['unchecked_value'])) {
  66             $this->setUncheckedValue($options['unchecked_value']);
  67         }
  68
  69         if (isset($options['checked_value'])) {
  70             $this->setCheckedValue($options['checked_value']);
  71         }
  72
  73         return $this;
  74     }
  75
  76     /**
  77      * Do we render hidden element?
  78      *
  79      * @param  bool $useHiddenElement
  80      * @return Checkbox
  81      */
  82     public function setUseHiddenElement($useHiddenElement)
  83     {
  84         $this->useHiddenElement = (bool) $useHiddenElement;
  85         return $this;
  86     }
  87
  88     /**
  89      * Do we render hidden element?
  90      *
  91      * @return bool
  92      */
  93     public function useHiddenElement()
  94     {
  95         return $this->useHiddenElement;
  96     }
  97
  98     /**
  99      * Set the value to use when checkbox is unchecked
 100      *
 101      * @param $uncheckedValue
 102      * @return Checkbox
 103      */
 104     public function setUncheckedValue($uncheckedValue)
 105     {
 106         $this->uncheckedValue = $uncheckedValue;
 107         return $this;
 108     }
 109
 110     /**
 111      * Get the value to use when checkbox is unchecked
 112      *
 113      * @return string
 114      */
 115     public function getUncheckedValue()
 116     {
 117         return $this->uncheckedValue;
 118     }
 119
 120     /**
 121      * Set the value to use when checkbox is checked
 122      *
 123      * @param $checkedValue
 124      * @return Checkbox
 125      */
 126     public function setCheckedValue($checkedValue)
 127     {
 128         $this->checkedValue = $checkedValue;
 129         return $this;
 130     }
 131
 132     /**
 133      * Get the value to use when checkbox is checked
 134      *
 135      * @return string
 136      */
 137     public function getCheckedValue()
 138     {
 139         return $this->checkedValue;
 140     }
 141
 142     /**
 143      * Get validator
 144      *
 145      * @return \Zend\Validator\ValidatorInterface
 146      */
 147     protected function getValidator()
 148     {
 149         if (null === $this->validator) {
 150             $this->validator = new InArrayValidator([
 151                 'haystack' => [$this->checkedValue, $this->uncheckedValue],
 152                 'strict'   => false
 153             ]);
 154         }
 155         return $this->validator;
 156     }
 157
 158     /**
 159      * Provide default input rules for this element
 160      *
 161      * Attaches the captcha as a validator.
 162      *
 163      * @return array
 164      */
 165     public function getInputSpecification()
 166     {
 167         $spec = [
 168             'name' => $this->getName(),
 169             'required' => true,
 170         ];
 171
 172         if ($validator = $this->getValidator()) {
 173             $spec['validators'] = [
 174                 $validator,
 175             ];
 176         }
 177
 178         return $spec;
 179     }
 180
 181     /**
 182      * Checks if this checkbox is checked.
 183      *
 184      * @return bool
 185      */
 186     public function isChecked()
 187     {
 188         return $this->value === $this->getCheckedValue();
 189     }
 190
 191     /**
 192      * Checks or unchecks the checkbox.
 193      *
 194      * @param bool $value The flag to set.
 195      * @return Checkbox
 196      */
 197     public function setChecked($value)
 198     {
 199         $this->value = $value ? $this->getCheckedValue() : $this->getUncheckedValue();
 200         return $this;
 201     }
 202
 203     /**
 204      * Checks or unchecks the checkbox.
 205      *
 206      * @param mixed $value A boolean flag or string that is checked against the "checked value".
 207      * @return Element
 208      */
 209     public function setValue($value)
 210     {
 211         // Cast to strings because POST data comes in string form
 212         $checked = (string) $value === (string) $this->getCheckedValue();
 213         $this->value = $checked ? $this->getCheckedValue() : $this->getUncheckedValue();
 214         return $this;
 215     }
 216 }