vendor/symfony/symfony/src/Symfony/Component/Form/Extension/Core/Type/DateType.php line 27

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form\Extension\Core\Type;
  14. use Symfony\Component\Form\AbstractType;
  15. use Symfony\Component\Form\FormInterface;
  16. use Symfony\Component\Form\FormBuilderInterface;
  17. use Symfony\Component\Form\FormView;
  18. use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToLocalizedStringTransformer;
  19. use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToArrayTransformer;
  20. use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToStringTransformer;
  21. use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeToTimestampTransformer;
  22. use Symfony\Component\Form\ReversedTransformer;
  23. use Symfony\Component\OptionsResolver\Options;
  24. use Symfony\Component\OptionsResolver\OptionsResolver;
  25. use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
  27. class DateType extends AbstractType
  28. {
  29.     const DEFAULT_FORMAT = \IntlDateFormatter::MEDIUM;
  30.     const HTML5_FORMAT = 'yyyy-MM-dd';
  32.     private static $acceptedFormats = array(
  33.         \IntlDateFormatter::FULL,
  34.         \IntlDateFormatter::LONG,
  35.         \IntlDateFormatter::MEDIUM,
  36.         \IntlDateFormatter::SHORT,
  37.     );
  39.     private static $widgets = array(
  40.         'text' => 'Symfony\Component\Form\Extension\Core\Type\TextType',
  41.         'choice' => 'Symfony\Component\Form\Extension\Core\Type\ChoiceType',
  42.     );
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function buildForm(FormBuilderInterface $builder, array $options)
  48.     {
  49.         $dateFormat = is_int($options['format']) ? $options['format'] : self::DEFAULT_FORMAT;
  50.         $timeFormat = \IntlDateFormatter::NONE;
  51.         $calendar = \IntlDateFormatter::GREGORIAN;
  52.         $pattern = is_string($options['format']) ? $options['format'] : null;
  54.         if (!in_array($dateFormat, self::$acceptedFormats, true)) {
  55.             throw new InvalidOptionsException('The "format" option must be one of the IntlDateFormatter constants (FULL, LONG, MEDIUM, SHORT) or a string representing a custom format.');
  56.         }
  58.         if ('single_text' === $options['widget']) {
  59.             if (null !== $pattern && false === strpos($pattern, 'y') && false === strpos($pattern, 'M') && false === strpos($pattern, 'd')) {
  60.                 throw new InvalidOptionsException(sprintf('The "format" option should contain the letters "y", "M" or "d". Its current value is "%s".', $pattern));
  61.             }
  63.             $builder->addViewTransformer(new DateTimeToLocalizedStringTransformer(
  64.                 $options['model_timezone'],
  65.                 $options['view_timezone'],
  66.                 $dateFormat,
  67.                 $timeFormat,
  68.                 $calendar,
  69.                 $pattern
  70.             ));
  71.         } else {
  72.             if (null !== $pattern && (false === strpos($pattern, 'y') || false === strpos($pattern, 'M') || false === strpos($pattern, 'd'))) {
  73.                 throw new InvalidOptionsException(sprintf('The "format" option should contain the letters "y", "M" and "d". Its current value is "%s".', $pattern));
  74.             }
  76.             $yearOptions = $monthOptions = $dayOptions = array(
  77.                 'error_bubbling' => true,
  78.             );
  80.             $formatter = new \IntlDateFormatter(
  81.                 \Locale::getDefault(),
  82.                 $dateFormat,
  83.                 $timeFormat,
  84.                 // see https://bugs.php.net/bug.php?id=66323
  85.                 class_exists('IntlTimeZone', false) ? \IntlTimeZone::createDefault() : null,
  86.                 $calendar,
  87.                 $pattern
  88.             );
  90.             // new \IntlDateFormatter may return null instead of false in case of failure, see https://bugs.php.net/bug.php?id=66323
  91.             if (!$formatter) {
  92.                 throw new InvalidOptionsException(intl_get_error_message(), intl_get_error_code());
  93.             }
  95.             $formatter->setLenient(false);
  97.             if ('choice' === $options['widget']) {
  98.                 // Only pass a subset of the options to children
  99.                 $yearOptions['choices'] = $this->formatTimestamps($formatter, '/y+/', $this->listYears($options['years']));
  100.                 $yearOptions['placeholder'] = $options['placeholder']['year'];
  101.                 $yearOptions['choice_translation_domain'] = $options['choice_translation_domain']['year'];
  102.                 $monthOptions['choices'] = $this->formatTimestamps($formatter, '/[M|L]+/', $this->listMonths($options['months']));
  103.                 $monthOptions['placeholder'] = $options['placeholder']['month'];
  104.                 $monthOptions['choice_translation_domain'] = $options['choice_translation_domain']['month'];
  105.                 $dayOptions['choices'] = $this->formatTimestamps($formatter, '/d+/', $this->listDays($options['days']));
  106.                 $dayOptions['placeholder'] = $options['placeholder']['day'];
  107.                 $dayOptions['choice_translation_domain'] = $options['choice_translation_domain']['day'];
  108.             }
  110.             // Append generic carry-along options
  111.             foreach (array('required', 'translation_domain') as $passOpt) {
  112.                 $yearOptions[$passOpt] = $monthOptions[$passOpt] = $dayOptions[$passOpt] = $options[$passOpt];
  113.             }
  115.             $builder
  116.                 ->add('year', self::$widgets[$options['widget']], $yearOptions)
  117.                 ->add('month', self::$widgets[$options['widget']], $monthOptions)
  118.                 ->add('day', self::$widgets[$options['widget']], $dayOptions)
  119.                 ->addViewTransformer(new DateTimeToArrayTransformer(
  120.                     $options['model_timezone'], $options['view_timezone'], array('year', 'month', 'day')
  121.                 ))
  122.                 ->setAttribute('formatter', $formatter)
  123.             ;
  124.         }
  126.         if ('string' === $options['input']) {
  127.             $builder->addModelTransformer(new ReversedTransformer(
  128.                 new DateTimeToStringTransformer($options['model_timezone'], $options['model_timezone'], 'Y-m-d')
  129.             ));
  130.         } elseif ('timestamp' === $options['input']) {
  131.             $builder->addModelTransformer(new ReversedTransformer(
  132.                 new DateTimeToTimestampTransformer($options['model_timezone'], $options['model_timezone'])
  133.             ));
  134.         } elseif ('array' === $options['input']) {
  135.             $builder->addModelTransformer(new ReversedTransformer(
  136.                 new DateTimeToArrayTransformer($options['model_timezone'], $options['model_timezone'], array('year', 'month', 'day'))
  137.             ));
  138.         }
  139.     }
  141.     /**
  142.      * {@inheritdoc}
  143.      */
  144.     public function finishView(FormView $view, FormInterface $form, array $options)
  145.     {
  146.         $view->vars['widget'] = $options['widget'];
  148.         // Change the input to a HTML5 date input if
  149.         //  * the widget is set to "single_text"
  150.         //  * the format matches the one expected by HTML5
  151.         //  * the html5 is set to true
  152.         if ($options['html5'] && 'single_text' === $options['widget'] && self::HTML5_FORMAT === $options['format']) {
  153.             $view->vars['type'] = 'date';
  154.         }
  156.         if ($form->getConfig()->hasAttribute('formatter')) {
  157.             $pattern = $form->getConfig()->getAttribute('formatter')->getPattern();
  159.             // remove special characters unless the format was explicitly specified
  160.             if (!is_string($options['format'])) {
  161.                 // remove quoted strings first
  162.                 $pattern = preg_replace('/\'[^\']+\'/', '', $pattern);
  164.                 // remove remaining special chars
  165.                 $pattern = preg_replace('/[^yMd]+/', '', $pattern);
  166.             }
  168.             // set right order with respect to locale (e.g.: de_DE=dd.MM.yy; en_US=M/d/yy)
  169.             // lookup various formats at http://userguide.icu-project.org/formatparse/datetime
  170.             if (preg_match('/^([yMd]+)[^yMd]*([yMd]+)[^yMd]*([yMd]+)$/', $pattern)) {
  171.                 $pattern = preg_replace(array('/y+/', '/M+/', '/d+/'), array('{{ year }}', '{{ month }}', '{{ day }}'), $pattern);
  172.             } else {
  173.                 // default fallback
  174.                 $pattern = '{{ year }}{{ month }}{{ day }}';
  175.             }
  177.             $view->vars['date_pattern'] = $pattern;
  178.         }
  179.     }
  181.     /**
  182.      * {@inheritdoc}
  183.      */
  184.     public function configureOptions(OptionsResolver $resolver)
  185.     {
  186.         $compound = function (Options $options) {
  187.             return 'single_text' !== $options['widget'];
  188.         };
  190.         $placeholderDefault = function (Options $options) {
  191.             return $options['required'] ? null : '';
  192.         };
  194.         $placeholderNormalizer = function (Options $options, $placeholder) use ($placeholderDefault) {
  195.             if (is_array($placeholder)) {
  196.                 $default = $placeholderDefault($options);
  198.                 return array_merge(
  199.                     array('year' => $default, 'month' => $default, 'day' => $default),
  200.                     $placeholder
  201.                 );
  202.             }
  204.             return array(
  205.                 'year' => $placeholder,
  206.                 'month' => $placeholder,
  207.                 'day' => $placeholder,
  208.             );
  209.         };
  211.         $choiceTranslationDomainNormalizer = function (Options $options, $choiceTranslationDomain) {
  212.             if (is_array($choiceTranslationDomain)) {
  213.                 $default = false;
  215.                 return array_replace(
  216.                     array('year' => $default, 'month' => $default, 'day' => $default),
  217.                     $choiceTranslationDomain
  218.                 );
  219.             }
  221.             return array(
  222.                 'year' => $choiceTranslationDomain,
  223.                 'month' => $choiceTranslationDomain,
  224.                 'day' => $choiceTranslationDomain,
  225.             );
  226.         };
  228.         $format = function (Options $options) {
  229.             return 'single_text' === $options['widget'] ? DateType::HTML5_FORMAT : DateType::DEFAULT_FORMAT;
  230.         };
  232.         $resolver->setDefaults(array(
  233.             'years' => range(date('Y') - 5, date('Y') + 5),
  234.             'months' => range(1, 12),
  235.             'days' => range(1, 31),
  236.             'widget' => 'choice',
  237.             'input' => 'datetime',
  238.             'format' => $format,
  239.             'model_timezone' => null,
  240.             'view_timezone' => null,
  241.             'placeholder' => $placeholderDefault,
  242.             'html5' => true,
  243.             // Don't modify \DateTime classes by reference, we treat
  244.             // them like immutable value objects
  245.             'by_reference' => false,
  246.             'error_bubbling' => false,
  247.             // If initialized with a \DateTime object, FormType initializes
  248.             // this option to "\DateTime". Since the internal, normalized
  249.             // representation is not \DateTime, but an array, we need to unset
  250.             // this option.
  251.             'data_class' => null,
  252.             'compound' => $compound,
  253.             'choice_translation_domain' => false,
  254.         ));
  256.         $resolver->setNormalizer('placeholder', $placeholderNormalizer);
  257.         $resolver->setNormalizer('choice_translation_domain', $choiceTranslationDomainNormalizer);
  259.         $resolver->setAllowedValues('input', array(
  260.             'datetime',
  261.             'string',
  262.             'timestamp',
  263.             'array',
  264.         ));
  265.         $resolver->setAllowedValues('widget', array(
  266.             'single_text',
  267.             'text',
  268.             'choice',
  269.         ));
  271.         $resolver->setAllowedTypes('format', array('int', 'string'));
  272.         $resolver->setAllowedTypes('years', 'array');
  273.         $resolver->setAllowedTypes('months', 'array');
  274.         $resolver->setAllowedTypes('days', 'array');
  275.     }
  277.     /**
  278.      * {@inheritdoc}
  279.      */
  280.     public function getBlockPrefix()
  281.     {
  282.         return 'date';
  283.     }
  285.     private function formatTimestamps(\IntlDateFormatter $formatter, $regex, array $timestamps)
  286.     {
  287.         $pattern = $formatter->getPattern();
  288.         $timezone = $formatter->getTimeZoneId();
  289.         $formattedTimestamps = array();
  291.         $formatter->setTimeZone('UTC');
  293.         if (preg_match($regex, $pattern, $matches)) {
  294.             $formatter->setPattern($matches[0]);
  296.             foreach ($timestamps as $timestamp => $choice) {
  297.                 $formattedTimestamps[$formatter->format($timestamp)] = $choice;
  298.             }
  300.             // I'd like to clone the formatter above, but then we get a
  301.             // segmentation fault, so let's restore the old state instead
  302.             $formatter->setPattern($pattern);
  303.         }
  305.         $formatter->setTimeZone($timezone);
  307.         return $formattedTimestamps;
  308.     }
  310.     private function listYears(array $years)
  311.     {
  312.         $result = array();
  314.         foreach ($years as $year) {
  315.             if (false !== $y = gmmktime(0, 0, 0, 6, 15, $year)) {
  316.                 $result[$y] = $year;
  317.             }
  318.         }
  320.         return $result;
  321.     }
  323.     private function listMonths(array $months)
  324.     {
  325.         $result = array();
  327.         foreach ($months as $month) {
  328.             $result[gmmktime(0, 0, 0, $month, 15)] = $month;
  329.         }
  331.         return $result;
  332.     }
  334.     private function listDays(array $days)
  335.     {
  336.         $result = array();
  338.         foreach ($days as $day) {
  339.             $result[gmmktime(0, 0, 0, 5, $day)] = $day;
  340.         }
  342.         return $result;
  343.     }
  344. }