Valdi\Validator\AbstractDateTimeComparator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	7
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getDateTimeFormat()	0	8	2
A	getDateTimes()	0	14	4
A	isValid()	0	20	4
	isValidComparison()	0	1	?
A	getInvalidDetails()	0	3	1

<?php

/*
 * This file is part of the Valdi package.
 *
 * (c) Philip Lehmann-Böhm <philip@philiplb.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valdi\Validator;

use Valdi\ValidationException;

/**
 * Abstract validator to compare date times.
 * For the format, see:
 * http://php.net/manual/en/datetime.createfromformat.php
 */
abstract class AbstractDateTimeComparator extends AbstractParametrizedValidator {

    /**
     * Holds the amount of parameters.
     */
    protected $amountOfParameters = 1;

    /**
     * Holds the type of the validator.
     */
    protected $type;

    /**
     * Holds whether to parse the parameters as \DateTimes so the child class
     * can decide.
     */
    protected $dateTimeParameters = true;

    /**
     * Compares date times.
     *
     * @param \DateTime $date
     * the first date to compare
     * @param \DateTime[] $datetimes
     * the date times to compare to
     * @param array $parameters
     * the original validator parameters
     *
     * @return boolean
     * true if the dates compare
     */
    abstract protected function isValidComparison(\DateTime $date, array $datetimes, array $parameters);

    /**
     * Gets a date time format from the parameters if given or a default one.
     *
     * @param string[] $parameters
     * the parameters
     *
     * @return string
     * the date time format
     */
    protected function getDateTimeFormat($parameters) {
        $format          = 'Y-m-d H:i:s';
        $parametersCount = count($parameters);
        if ($parametersCount > $this->amountOfParameters) {
            $format = $parameters[$parametersCount - 1];
        }
        return $format;
    }

    /**
     * Interprets the given parameters as date times and returns them.
     *
     * @param array $parameters
     * the paramters
     * @param string $format
     * the date time format
     *
     * @return \DateTime[]
     * the date times
     */
    protected function getDateTimes(array $parameters, $format) {
        if (!$this->dateTimeParameters) {
            return array();
        }
        $datetimes = array();
        for ($i = 0; $i < $this->amountOfParameters; ++$i) {
            $datetime = \DateTime::createFromFormat($format, $parameters[$i]);
            if ($datetime === false) {
                throw new ValidationException('"'.$this->type.'" expects a date of the format "'.$format.'".');
            }
            $datetimes[] = $datetime;
        }
        return $datetimes;
    }

    /**
     * {@inheritdoc}
     */
    public function isValid($value, array $parameters) {

        if (count($parameters) < $this->amountOfParameters) {
            throw new ValidationException('"'.$this->type.'" expects at least '.$this->amountOfParameters.' parameter.');
        }

        if (in_array($value, array('', null), true)) {
            return true;
        }

        $format = $this->getDateTimeFormat($parameters);

        $datetimes = $this->getDateTimes($parameters, $format);
        $date      = \DateTime::createFromFormat($format, $value);
        if ($date === false) {
            return false;
        }

        return $this->isValidComparison($date, $datetimes, $parameters);
    }

    /**
     * {@inheritdoc}
     */
    public function getInvalidDetails() {
        return $this->type;
    }
}