interface/modules/zend_modules/library/Zend/Form/Element/DateSelect.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 DateTime as PhpDateTime;
  13 use Zend\Form\Exception\InvalidArgumentException;
  14 use Zend\Form\FormInterface;
  15 use Zend\Validator\ValidatorInterface;
  16 use Zend\Validator\Date as DateValidator;
  17 use Exception;
  18
  19 class DateSelect extends MonthSelect
  20 {
  21     /**
  22      * Select form element that contains values for day
  23      *
  24      * @var Select
  25      */
  26     protected $dayElement;
  27
  28     /**
  29      * Constructor. Add the day select element
  30      *
  31      * @param  null|int|string  $name    Optional name for the element
  32      * @param  array            $options Optional options for the element
  33      */
  34     public function __construct($name = null, $options = array())
  35     {
  36         $this->dayElement = new Select('day');
  37
  38         parent::__construct($name, $options);
  39     }
  40
  41     /**
  42      * Accepted options for DateSelect (plus the ones from MonthSelect) :
  43      * - day_attributes: HTML attributes to be rendered with the day element
  44      *
  45      * @param array|\Traversable $options
  46      * @return self
  47      */
  48     public function setOptions($options)
  49     {
  50         parent::setOptions($options);
  51
  52         if (isset($options['day_attributes'])) {
  53             $this->setDayAttributes($options['day_attributes']);
  54         }
  55
  56         return $this;
  57     }
  58
  59     /**
  60      * @return Select
  61      */
  62     public function getDayElement()
  63     {
  64         return $this->dayElement;
  65     }
  66
  67     /**
  68      * Get both the year and month elements
  69      *
  70      * @return array
  71      */
  72     public function getElements()
  73     {
  74         return array_merge(array($this->dayElement), parent::getElements());
  75     }
  76
  77     /**
  78      * Set the day attributes
  79      *
  80      * @param  array $dayAttributes
  81      * @return self
  82      */
  83     public function setDayAttributes(array $dayAttributes)
  84     {
  85         $this->dayElement->setAttributes($dayAttributes);
  86         return $this;
  87     }
  88
  89     /**
  90      * Get the day attributes
  91      *
  92      * @return array
  93      */
  94     public function getDayAttributes()
  95     {
  96         return $this->dayElement->getAttributes();
  97     }
  98
  99     /**
 100      * @param  string|array|\ArrayAccess|PhpDateTime $value
 101      * @throws \Zend\Form\Exception\InvalidArgumentException
 102      * @return self Provides a fluent interface
 103      */
 104     public function setValue($value)
 105     {
 106         if (is_string($value)) {
 107             try {
 108                 $value = new PhpDateTime($value);
 109             } catch (Exception $e) {
 110                 throw new InvalidArgumentException('Value should be a parsable string or an instance of DateTime');
 111             }
 112         }
 113
 114         if ($value instanceof PhpDateTime) {
 115             $value = array(
 116                 'year'  => $value->format('Y'),
 117                 'month' => $value->format('m'),
 118                 'day'   => $value->format('d'),
 119             );
 120         }
 121
 122         $this->yearElement->setValue($value['year']);
 123         $this->monthElement->setValue($value['month']);
 124         $this->dayElement->setValue($value['day']);
 125
 126         return $this;
 127     }
 128
 129     /**
 130      * @return String
 131      */
 132     public function getValue()
 133     {
 134         return sprintf(
 135             '%s-%s-%s',
 136             $this->getYearElement()->getValue(),
 137             $this->getMonthElement()->getValue(),
 138             $this->getDayElement()->getValue()
 139         );
 140     }
 141
 142     /**
 143      * Prepare the form element (mostly used for rendering purposes)
 144      *
 145      * @param  FormInterface $form
 146      * @return mixed
 147      */
 148     public function prepareElement(FormInterface $form)
 149     {
 150         parent::prepareElement($form);
 151
 152         $name = $this->getName();
 153         $this->dayElement->setName($name . '[day]');
 154     }
 155
 156     /**
 157      * Get validator
 158      *
 159      * @return ValidatorInterface
 160      */
 161     protected function getValidator()
 162     {
 163         if (null === $this->validator) {
 164             $this->validator = new DateValidator(array('format' => 'Y-m-d'));
 165         }
 166
 167         return $this->validator;
 168     }
 169
 170     /**
 171      * Should return an array specification compatible with
 172      * {@link Zend\InputFilter\Factory::createInput()}.
 173      *
 174      * @return array
 175      */
 176     public function getInputSpecification()
 177     {
 178         return array(
 179             'name' => $this->getName(),
 180             'required' => false,
 181             'filters' => array(
 182                 array('name' => 'DateSelect')
 183             ),
 184             'validators' => array(
 185                 $this->getValidator(),
 186             )
 187         );
 188     }
 189
 190     /**
 191      * Clone the element (this is needed by Collection element, as it needs different copies of the elements)
 192      */
 193     public function __clone()
 194     {
 195         $this->dayElement   = clone $this->dayElement;
 196         $this->monthElement = clone $this->monthElement;
 197         $this->yearElement  = clone $this->yearElement;
 198     }
 199 }