interface/modules/zend_modules/library/Zend/Form/Element/DateTime.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 DateInterval;
  13 use DateTime as PhpDateTime;
  14 use Zend\Form\Element;
  15 use Zend\InputFilter\InputProviderInterface;
  16 use Zend\Validator\Date as DateValidator;
  17 use Zend\Validator\DateStep as DateStepValidator;
  18 use Zend\Validator\GreaterThan as GreaterThanValidator;
  19 use Zend\Validator\LessThan as LessThanValidator;
  20
  21 class DateTime extends Element implements InputProviderInterface
  22 {
  23     const DATETIME_FORMAT = 'Y-m-d\TH:iP';
  24
  25     /**
  26      * Seed attributes
  27      *
  28      * @var array
  29      */
  30     protected $attributes = array(
  31         'type' => 'datetime',
  32     );
  33
  34     /**
  35      * A valid format string accepted by date()
  36      *
  37      * @var string
  38      */
  39     protected $format = self::DATETIME_FORMAT;
  40
  41     /**
  42      * @var array
  43      */
  44     protected $validators;
  45
  46     /**
  47      * Accepted options for DateTime:
  48      * - format: A \DateTime compatible string
  49      *
  50      * @param array|\Traversable $options
  51      * @return DateTime
  52      */
  53     public function setOptions($options)
  54     {
  55         parent::setOptions($options);
  56
  57         if (isset($this->options['format'])) {
  58             $this->setFormat($this->options['format']);
  59         }
  60
  61         return $this;
  62     }
  63
  64     /**
  65      * Retrieve the element value
  66      *
  67      * If the value is a DateTime object, and $returnFormattedValue is true
  68      * (the default), we return the string
  69      * representation using the currently registered format.
  70      *
  71      * If $returnFormattedValue is false, the original value will be
  72      * returned, regardless of type.
  73      *
  74      * @param  bool $returnFormattedValue
  75      * @return mixed
  76      */
  77     public function getValue($returnFormattedValue = true)
  78     {
  79         $value = parent::getValue();
  80         if (!$value instanceof PhpDateTime || !$returnFormattedValue) {
  81             return $value;
  82         }
  83         $format = $this->getFormat();
  84         return $value->format($format);
  85     }
  86
  87     /**
  88      * Set value for format
  89      *
  90      * @param  string $format
  91      * @return DateTime
  92      */
  93     public function setFormat($format)
  94     {
  95         $this->format = (string) $format;
  96         return $this;
  97     }
  98
  99     /**
 100      * Retrieve the DateTime format to use for the value
 101      *
 102      * @return string
 103      */
 104     public function getFormat()
 105     {
 106         return $this->format;
 107     }
 108
 109     /**
 110      * Get validators
 111      *
 112      * @return array
 113      */
 114     protected function getValidators()
 115     {
 116         if ($this->validators) {
 117             return $this->validators;
 118         }
 119
 120         $validators = array();
 121         $validators[] = $this->getDateValidator();
 122
 123         if (isset($this->attributes['min'])) {
 124             $validators[] = new GreaterThanValidator(array(
 125                 'min'       => $this->attributes['min'],
 126                 'inclusive' => true,
 127             ));
 128         }
 129         if (isset($this->attributes['max'])) {
 130             $validators[] = new LessThanValidator(array(
 131                 'max'       => $this->attributes['max'],
 132                 'inclusive' => true,
 133             ));
 134         }
 135         if (!isset($this->attributes['step'])
 136             || 'any' !== $this->attributes['step']
 137         ) {
 138             $validators[] = $this->getStepValidator();
 139         }
 140
 141         $this->validators = $validators;
 142         return $this->validators;
 143     }
 144
 145     /**
 146      * Retrieves a Date Validator configured for a DateTime Input type
 147      *
 148      * @return DateTime
 149      */
 150     protected function getDateValidator()
 151     {
 152         return new DateValidator(array('format' => $this->format));
 153     }
 154
 155     /**
 156      * Retrieves a DateStep Validator configured for a DateTime Input type
 157      *
 158      * @return DateTime
 159      */
 160     protected function getStepValidator()
 161     {
 162         $format    = $this->getFormat();
 163         $stepValue = (isset($this->attributes['step']))
 164                    ? $this->attributes['step'] : 1; // Minutes
 165
 166         $baseValue = (isset($this->attributes['min']))
 167                    ? $this->attributes['min'] : date($format, 0);
 168
 169         return new DateStepValidator(array(
 170             'format'    => $format,
 171             'baseValue' => $baseValue,
 172             'step'      => new DateInterval("PT{$stepValue}M"),
 173         ));
 174     }
 175
 176     /**
 177      * Provide default input rules for this element
 178      *
 179      * Attaches default validators for the datetime input.
 180      *
 181      * @return array
 182      */
 183     public function getInputSpecification()
 184     {
 185         return array(
 186             'name' => $this->getName(),
 187             'required' => true,
 188             'filters' => array(
 189                 array('name' => 'Zend\Filter\StringTrim'),
 190             ),
 191             'validators' => $this->getValidators(),
 192         );
 193     }
 194 }