DateTimeSelect.php

<?php

declare(strict_types=1);

namespace Laminas\Form\Element;

use DateTime as PhpDateTime;
use DateTimeInterface;
use Exception;
use Laminas\Form\Exception\InvalidArgumentException;
use Laminas\Form\FormInterface;
use Laminas\Validator\Date as DateValidator;
use Laminas\Validator\ValidatorInterface;

use function array_merge;
use function is_array;
use function is_string;
use function sprintf;

class DateTimeSelect extends DateSelect
{
    /**
     * Select form element that contains values for hour
     *
     * @var Select
     */
    protected $hourElement;

    /**
     * Select form element that contains values for minute
     *
     * @var Select
     */
    protected $minuteElement;

    /**
     * Select form element that contains values for second
     *
     * @var Select
     */
    protected $secondElement;

    /**
     * Is the seconds select shown when the element is rendered?
     *
     * @var bool
     */
    protected $shouldShowSeconds = false;

    /**
     * Constructor. Add the hour, minute and second select elements
     *
     * @param  null|int|string  $name    Optional name for the element
     * @param  array            $options Optional options for the element
     */
    public function __construct($name = null, array $options = [])
    {
        parent::__construct($name, $options);

        $this->hourElement   = new Select('hour');
        $this->minuteElement = new Select('minute');
        $this->secondElement = new Select('second');
    }

    /**
     * Set options for DateTimeSelect element.
     *
     * Accepted options for DateTimeSelect (plus the ones from DateSelect):
     *
     * - hour_attributes: HTML attributes to be rendered with the hour element
     * - minute_attributes: HTML attributes to be rendered with the minute element
     * - second_attributes: HTML attributes to be rendered with the second element
     * - should_show_seconds: if set to true, the seconds select is shown
     *
     * @return $this
     */
    public function setOptions(iterable $options)
    {
        parent::setOptions($options);

        if (isset($this->options['hour_attributes'])) {
            $this->setHourAttributes($this->options['hour_attributes']);
        }

        if (isset($this->options['minute_attributes'])) {
            $this->setMinuteAttributes($this->options['minute_attributes']);
        }

        if (isset($this->options['second_attributes'])) {
            $this->setSecondAttributes($this->options['second_attributes']);
        }

        if (isset($this->options['should_show_seconds'])) {
            $this->setShouldShowSeconds($this->options['should_show_seconds']);
        }

        return $this;
    }

    public function getHourElement(): Select
    {
        return $this->hourElement;
    }

    public function getMinuteElement(): Select
    {
        return $this->minuteElement;
    }

    public function getSecondElement(): Select
    {
        return $this->secondElement;
    }

    /** @return list<Select> */
    public function getElements(): array
    {
        return array_merge(parent::getElements(), [
            $this->hourElement,
            $this->minuteElement,
            $this->secondElement,
        ]);
    }

    /**
     * Set the hour attributes
     *
     * @param array<string, scalar|null> $hourAttributes
     * @return $this
     */
    public function setHourAttributes(array $hourAttributes)
    {
        $this->hourElement->setAttributes($hourAttributes);
        return $this;
    }

    /**
     * Get the hour attributes
     *
     * @return array<string, scalar|null>
     */
    public function getHourAttributes(): array
    {
        return $this->hourElement->getAttributes();
    }

    /**
     * Set the minute attributes
     *
     * @param array<string, scalar|null> $minuteAttributes
     * @return $this
     */
    public function setMinuteAttributes(array $minuteAttributes)
    {
        $this->minuteElement->setAttributes($minuteAttributes);
        return $this;
    }

    /**
     * Get the minute attributes
     *
     * @return array<string, scalar|null>
     */
    public function getMinuteAttributes(): array
    {
        return $this->minuteElement->getAttributes();
    }

    /**
     * Set the second attributes
     *
     * @param array<string, scalar|null> $secondAttributes
     * @return $this
     */
    public function setSecondAttributes(array $secondAttributes)
    {
        $this->secondElement->setAttributes($secondAttributes);
        return $this;
    }

    /**
     * Get the second attributes
     *
     * @return array<string, scalar|null>
     */
    public function getSecondAttributes(): array
    {
        return $this->secondElement->getAttributes();
    }

    /**
     * If set to true, this indicate that the second select is shown. If set to true, the seconds will be
     * assumed to always be 00
     *
     * @return $this
     */
    public function setShouldShowSeconds(bool $shouldShowSeconds)
    {
        $this->shouldShowSeconds = $shouldShowSeconds;
        return $this;
    }

    public function shouldShowSeconds(): bool
    {
        return $this->shouldShowSeconds;
    }

    /**
     * @param  PhpDateTime|iterable|string|null|mixed $value
     * @return $this
     * @throws InvalidArgumentException
     */
    public function setValue($value)
    {
        if (is_string($value)) {
            try {
                $value = new PhpDateTime($value);
            } catch (Exception) {
                throw new InvalidArgumentException('Value should be a parsable string or an instance of \DateTime');
            }
        }

        if (null === $value && ! $this->shouldCreateEmptyOption()) {
            $value = new PhpDateTime();
        }

        if ($value instanceof DateTimeInterface) {
            $value = [
                'year'   => $value->format('Y'),
                'month'  => $value->format('m'),
                'day'    => $value->format('d'),
                'hour'   => $value->format('H'),
                'minute' => $value->format('i'),
                'second' => $value->format('s'),
            ];
        }

        if (is_array($value)) {
            $this->yearElement->setValue($value['year']);
            $this->monthElement->setValue($value['month']);
            $this->dayElement->setValue($value['day']);
            $this->hourElement->setValue($value['hour']);
            $this->minuteElement->setValue($value['minute']);
            $this->secondElement->setValue($value['second'] ?? '00');
        } else {
            $this->yearElement->setValue(null);
            $this->monthElement->setValue(null);
            $this->dayElement->setValue(null);
            $this->hourElement->setValue(null);
            $this->minuteElement->setValue(null);
            $this->secondElement->setValue(null);
        }

        return $this;
    }

    public function getValue(): ?string
    {
        $year   = $this->getYearElement()->getValue();
        $month  = $this->getMonthElement()->getValue();
        $day    = $this->getDayElement()->getValue();
        $hour   = $this->getHourElement()->getValue();
        $minute = $this->getMinuteElement()->getValue();
        $second = $this->getSecondElement()->getValue();

        // if everything is null, return null
        if (
            $this->shouldCreateEmptyOption()
            && null === $year && null === $month && null === $day
            && null === $hour && null === $minute && (null === $second || '00' === $second)
        ) {
            return null;
        }

        // if time is given, but date is null, use current date
        if (
            $this->shouldCreateEmptyOption()
            && null === $year && null === $month && null === $day
        ) {
            $now   = new PhpDateTime();
            $year  = $now->format('Y');
            $month = $now->format('m');
            $day   = $now->format('d');
        }

        // if date is given, but time is null, use 00:00:00 instead
        if (
            $this->shouldCreateEmptyOption()
            && null === $hour && null === $minute && (null === $second || '00' === $second)
        ) {
            $hour   = '00';
            $minute = '00';
            $second = '00';
        }

        return sprintf(
            '%04d-%02d-%02d %02d:%02d:%02d',
            $year,
            $month,
            $day,
            $hour,
            $minute,
            $second
        );
    }

    /**
     * Prepare the form element (mostly used for rendering purposes)
     */
    public function prepareElement(FormInterface $form): void
    {
        parent::prepareElement($form);

        $name = $this->getName();
        $this->hourElement->setName($name . '[hour]');
        $this->minuteElement->setName($name . '[minute]');
        $this->secondElement->setName($name . '[second]');
    }

    /**
     * Get validator
     */
    protected function getValidator(): ValidatorInterface
    {
        if (null === $this->validator) {
            $this->validator = new DateValidator(['format' => 'Y-m-d H:i:s']);
        }

        return $this->validator;
    }

    /**
     * @inheritDoc
     */
    public function getInputSpecification(): array
    {
        $spec = [
            'required'   => false,
            'filters'    => [
                ['name' => 'DateTimeSelect'],
            ],
            'validators' => [
                $this->getValidator(),
            ],
        ];

        $name = $this->getName();
        if ($name !== null) {
            $spec['name'] = $name;
        }

        return $spec;
    }

    /**
     * Clone the element (this is needed by Collection element, as it needs different copies of the elements)
     */
    public function __clone()
    {
        $this->dayElement    = clone $this->dayElement;
        $this->monthElement  = clone $this->monthElement;
        $this->yearElement   = clone $this->yearElement;
        $this->hourElement   = clone $this->hourElement;
        $this->minuteElement = clone $this->minuteElement;
        $this->secondElement = clone $this->secondElement;
    }
}