interface/modules/zend_modules/library/Zend/Form/Element/MonthSelect.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 DateTime as PhpDateTime;
  13 use Zend\Form\Element;
  14 use Zend\Form\ElementPrepareAwareInterface;
  15 use Zend\Form\FormInterface;
  16 use Zend\InputFilter\InputProviderInterface;
  17 use Zend\Validator\Regex as RegexValidator;
  18 use Zend\Validator\ValidatorInterface;
  19
  20 class MonthSelect extends Element implements InputProviderInterface, ElementPrepareAwareInterface
  21 {
  22     /**
  23      * Select form element that contains values for month
  24      *
  25      * @var Select
  26      */
  27     protected $monthElement;
  28
  29     /**
  30      * Select form element that contains values for year
  31      *
  32      * @var Select
  33      */
  34     protected $yearElement;
  35
  36     /**
  37      * Min year to use for the select (default: current year - 100)
  38      *
  39      * @var int
  40      */
  41     protected $minYear;
  42
  43     /**
  44      * Max year to use for the select (default: current year)
  45      *
  46      * @var int
  47      */
  48     protected $maxYear;
  49
  50     /**
  51      * If set to true, it will generate an empty option for every select (this is mainly needed by most JavaScript
  52      * libraries to allow to have a placeholder)
  53      *
  54      * @var bool
  55      */
  56     protected $createEmptyOption = false;
  57
  58     /**
  59      * If set to true, view helpers will render delimiters between <select> elements, according to the
  60      * specified locale
  61      *
  62      * @var bool
  63      */
  64     protected $renderDelimiters = true;
  65
  66     /**
  67      * @var ValidatorInterface
  68      */
  69     protected $validator;
  70
  71
  72     /**
  73      * Constructor. Add two selects elements
  74      *
  75      * @param  null|int|string  $name    Optional name for the element
  76      * @param  array            $options Optional options for the element
  77      */
  78     public function __construct($name = null, $options = array())
  79     {
  80         $this->minYear = date('Y') - 100;
  81         $this->maxYear = date('Y');
  82
  83         $this->monthElement = new Select('month');
  84         $this->yearElement = new Select('year');
  85
  86         parent::__construct($name, $options);
  87     }
  88
  89     /**
  90      * Accepted options for DateSelect:
  91      * - month_attributes: HTML attributes to be rendered with the month element
  92      * - year_attributes: HTML attributes to be rendered with the month element
  93      * - min_year: min year to use in the year select
  94      * - max_year: max year to use in the year select
  95      *
  96      * @param array|\Traversable $options
  97      * @return MonthSelect
  98      */
  99     public function setOptions($options)
 100     {
 101         parent::setOptions($options);
 102
 103         if (isset($options['month_attributes'])) {
 104             $this->setMonthAttributes($options['month_attributes']);
 105         }
 106
 107         if (isset($options['year_attributes'])) {
 108             $this->setYearAttributes($options['year_attributes']);
 109         }
 110
 111         if (isset($options['min_year'])) {
 112             $this->setMinYear($options['min_year']);
 113         }
 114
 115         if (isset($options['max_year'])) {
 116             $this->setMaxYear($options['max_year']);
 117         }
 118
 119         if (isset($options['create_empty_option'])) {
 120             $this->setShouldCreateEmptyOption($options['create_empty_option']);
 121         }
 122
 123         if (isset($options['render_delimiters'])) {
 124             $this->setShouldRenderDelimiters($options['render_delimiters']);
 125         }
 126
 127         return $this;
 128     }
 129
 130     /**
 131      * @return Select
 132      */
 133     public function getMonthElement()
 134     {
 135         return $this->monthElement;
 136     }
 137
 138     /**
 139      * @return Select
 140      */
 141     public function getYearElement()
 142     {
 143         return $this->yearElement;
 144     }
 145
 146     /**
 147      * Set the month attributes
 148      *
 149      * @param  array $monthAttributes
 150      * @return MonthSelect
 151      */
 152     public function setMonthAttributes(array $monthAttributes)
 153     {
 154         $this->monthElement->setAttributes($monthAttributes);
 155         return $this;
 156     }
 157
 158     /**
 159      * Get the month attributes
 160      *
 161      * @return array
 162      */
 163     public function getMonthAttributes()
 164     {
 165         return $this->monthElement->getAttributes();
 166     }
 167
 168     /**
 169      * Set the year attributes
 170      *
 171      * @param  array $yearAttributes
 172      * @return MonthSelect
 173      */
 174     public function setYearAttributes(array $yearAttributes)
 175     {
 176         $this->yearElement->setAttributes($yearAttributes);
 177         return $this;
 178     }
 179
 180     /**
 181      * Get the year attributes
 182      *
 183      * @return array
 184      */
 185     public function getYearAttributes()
 186     {
 187         return $this->yearElement->getAttributes();
 188     }
 189
 190     /**
 191      * @param  int $minYear
 192      * @return MonthSelect
 193      */
 194     public function setMinYear($minYear)
 195     {
 196         $this->minYear = $minYear;
 197         return $this;
 198     }
 199
 200     /**
 201      * @return int
 202      */
 203     public function getMinYear()
 204     {
 205         return $this->minYear;
 206     }
 207
 208     /**
 209      * @param  int $maxYear
 210      * @return MonthSelect
 211      */
 212     public function setMaxYear($maxYear)
 213     {
 214         $this->maxYear = $maxYear;
 215         return $this;
 216     }
 217
 218     /**
 219      * @return int
 220      */
 221     public function getMaxYear()
 222     {
 223         return $this->maxYear;
 224     }
 225
 226     /**
 227      * @param  bool $createEmptyOption
 228      * @return MonthSelect
 229      */
 230     public function setShouldCreateEmptyOption($createEmptyOption)
 231     {
 232         $this->createEmptyOption = (bool) $createEmptyOption;
 233         return $this;
 234     }
 235
 236     /**
 237      * @return bool
 238      */
 239     public function shouldCreateEmptyOption()
 240     {
 241         return $this->createEmptyOption;
 242     }
 243
 244     /**
 245      * @param  bool $renderDelimiters
 246      * @return MonthSelect
 247      */
 248     public function setShouldRenderDelimiters($renderDelimiters)
 249     {
 250         $this->renderDelimiters = (bool) $renderDelimiters;
 251         return $this;
 252     }
 253
 254     /**
 255      * @return bool
 256      */
 257     public function shouldRenderDelimiters()
 258     {
 259         return $this->renderDelimiters;
 260     }
 261
 262     /**
 263      * @param mixed $value
 264      * @return void|\Zend\Form\Element
 265      */
 266     public function setValue($value)
 267     {
 268         if ($value instanceof PhpDateTime) {
 269             $value = array(
 270                 'year'  => $value->format('Y'),
 271                 'month' => $value->format('m')
 272             );
 273         }
 274
 275         $this->yearElement->setValue($value['year']);
 276         $this->monthElement->setValue($value['month']);
 277     }
 278
 279     /**
 280      * Prepare the form element (mostly used for rendering purposes)
 281      *
 282      * @param  FormInterface $form
 283      * @return mixed
 284      */
 285     public function prepareElement(FormInterface $form)
 286     {
 287         $name = $this->getName();
 288         $this->monthElement->setName($name . '[month]');
 289         $this->yearElement->setName($name . '[year]');
 290     }
 291
 292     /**
 293      * Get validator
 294      *
 295      * @return ValidatorInterface
 296      */
 297     protected function getValidator()
 298     {
 299         return new RegexValidator('/^[0-9]{4}\-(0?[1-9]|1[012])$/');
 300     }
 301
 302     /**
 303      * Should return an array specification compatible with
 304      * {@link Zend\InputFilter\Factory::createInput()}.
 305      *
 306      * @return array
 307      */
 308     public function getInputSpecification()
 309     {
 310         return array(
 311             'name' => $this->getName(),
 312             'required' => false,
 313             'filters' => array(
 314                 array(
 315                     'name'    => 'Callback',
 316                     'options' => array(
 317                         'callback' => function ($date) {
 318                             // Convert the date to a specific format
 319                             if (is_array($date)) {
 320                                 $date = $date['year'] . '-' . $date['month'];
 321                             }
 322
 323                             return $date;
 324                         }
 325                     )
 326                 )
 327             ),
 328             'validators' => array(
 329                 $this->getValidator(),
 330             )
 331         );
 332     }
 333
 334     /**
 335      * Clone the element (this is needed by Collection element, as it needs different copies of the elements)
 336      */
 337     public function __clone()
 338     {
 339         $this->monthElement = clone $this->monthElement;
 340         $this->yearElement  = clone $this->yearElement;
 341     }
 342 }