Surfnet\Stepup\DateTime\DateTime

Complexity

Total Complexity

17

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	now()	0	4	2
A	fromString()	0	14	3
A	__construct()	0	4	2
A	add()	0	7	1
A	sub()	0	7	1
A	endOfDay()	0	7	1
A	comesBefore()	0	4	1
A	comesBeforeOrIsEqual()	0	4	1
A	comesAfter()	0	4	1
A	comesAfterOrIsEqual()	0	4	1
A	format()	0	13	2
A	__toString()	0	4	1

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\Stepup\DateTime;

use DateInterval;
use DateTime as CoreDateTime;
use Surfnet\Stepup\Exception\InvalidArgumentException;

/**
 * @SuppressWarnings(PHPMD.TooManyMethods)
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class DateTime
{
    /**
     * The 'c' format, expanded in separate format characters. This string can also be used with
     * `DateTime::createFromString()`.
     */
    const FORMAT = 'Y-m-d\\TH:i:sP';

    /**
     * Allows for mocking of time.
     *
     * @var self|null
     */
    private static $now;

    /**
     * @var CoreDateTime
     */
    private $dateTime;

    /**
     * @return self
     */
    public static function now()
    {
        return self::$now ?: new self(new CoreDateTime);
    }

    /**
     * @param string $string A date-time string formatted using `self::FORMAT` (eg. '2014-11-26T15:20:43+01:00').
     * @return self
     */
    public static function fromString($string)
    {
        if (!is_string($string)) {
            InvalidArgumentException::invalidType('string', 'dateTime', $string);
        }

        $dateTime = CoreDateTime::createFromFormat(self::FORMAT, $string);

        if ($dateTime === false) {
            throw new InvalidArgumentException('Date-time string could not be parsed: is it formatted correctly?');
        }

        return new self($dateTime);
    }

    /**
     * @param CoreDateTime|null $dateTime
     */
    public function __construct(CoreDateTime $dateTime = null)
    {
        $this->dateTime = $dateTime ?: new CoreDateTime();
    }

    /**
     * @param DateInterval $interval
     * @return DateTime
     */
    public function add(DateInterval $interval)
    {
        $dateTime = clone $this->dateTime;
        $dateTime->add($interval);

        return new self($dateTime);
    }

    /**
     * @param DateInterval $interval
     * @return DateTime
     */
    public function sub(DateInterval $interval)
    {
        $dateTime = clone $this->dateTime;
        $dateTime->sub($interval);

        return new self($dateTime);
    }

    /**
     * @return DateTime
     */
    public function endOfDay()
    {
        $dateTime = clone $this->dateTime;
        $dateTime->setTime(23, 59, 59);

        return new self($dateTime);
    }

    /**
     * @param DateTime $dateTime
     * @return boolean
     */
    public function comesBefore(DateTime $dateTime)
    {
        return $this->dateTime < $dateTime->dateTime;
    }

    /**
     * @param DateTime $dateTime
     * @return boolean
     */
    public function comesBeforeOrIsEqual(DateTime $dateTime)
    {
        return $this->dateTime <= $dateTime->dateTime;
    }

    /**
     * @param DateTime $dateTime
     * @return boolean
     */
    public function comesAfter(DateTime $dateTime)
    {
        return $this->dateTime > $dateTime->dateTime;
    }

    /**
     * @param DateTime $dateTime
     * @return boolean
     */
    public function comesAfterOrIsEqual(DateTime $dateTime)
    {
        return $this->dateTime >= $dateTime->dateTime;
    }

    /**
     * @param $format
     * @return string
     */
    public function format($format)
    {
        $formatted = $this->dateTime->format($format);

        if ($formatted === false) {
            throw new InvalidArgumentException(sprintf(
                'Given format "%s" is not a valid format for DateTime',
                $format
            ));
        }

        return $formatted;
    }

    /**
     * @return string An ISO 8601 representation of this DateTime.
     */
    public function __toString()
    {
        return $this->format(self::FORMAT);
    }
}