Date::add() - Code Metrics - Inspection of "Add phpdoc for accurate return types" - palmtreephp/chrono - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 26e9e8...850720 )

by Andy

created 2018-12-30 13:22 UTC

Date::add() A

↳ Parent: Date

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	5
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace Palmtree\Chrono;

use Palmtree\Chrono\Option\ComparisonOperators;
use Palmtree\Chrono\Option\DatePeriods;
use Palmtree\Chrono\Option\TimePeriods;

class Date
{
    /** @var \DateTime */
    protected $dateTime;

    public function __construct(string $time = 'now', $timezone = null)
    {
        $this->dateTime = $this->createInternalDateTime($time, $timezone);

        $this->dateTime->setTime(0, 0);
    }

    public static function fromNative(\DateTime $dateTime): self
    {
        return new static($dateTime->format('Y-m-d H:i:s.u'), $dateTime->getTimezone());
    }

    public function toNative(): \DateTime
    {
        return clone $this->dateTime;
    }

    public function format(string $format): string
    {
        return $this->dateTime->format($format);
    }

    public function isSame(self $date, ?string $precision = null): bool
    {
        return $this->compareTo($date, ComparisonOperators::EQUAL_TO, $precision);
    }

    public function isBefore(self $date, ?string $precision = null): bool
    {
        return $this->compareTo($date, ComparisonOperators::LESS_THAN, $precision);
    }

    public function isSameOrBefore(self $date, ?string $precision = null): bool
    {
        return $this->compareTo($date, ComparisonOperators::LESS_THAN_OR_EQUAL_TO, $precision);
    }

    public function isAfter(self $date, ?string $precision = null): bool
    {
        return $this->compareTo($date, ComparisonOperators::GREATER_THAN, $precision);
    }

    public function isSameOrAfter(self $date, ?string $precision = null): bool
    {
        return $this->compareTo($date, ComparisonOperators::GREATER_THAN_OR_EQUAL_TO, $precision);
    }

    public function add(int $value, string $period): self
    {
        $this->dateTime->add($this->getDateInterval($value, $period));

        return $this;
    }

    public function subtract(int $value, string $period): self
    {
        $this->dateTime->sub($this->getDateInterval($value, $period));

        return $this;
    }

    public function isToday(): bool
    {
        $today = new self('now', $this->dateTime->getTimezone());

        return $this->isSame($today, DatePeriods::DAY);
    }

    public function setYear(int $year): self
    {
        return $this->setDate($year, $this->dateTime->format('m'), $this->dateTime->format('d'));
        return $this->setDate($year, /** @scrutinizer ignore-type */ $this->dateTime->format('m'), $this->dateTime->format('d'));
    }

    public function setMonth(int $month): self
    {
        return $this->setDate($this->dateTime->format('Y'), $month, $this->dateTime->format('d'));
        return $this->setDate($this->dateTime->format('Y'), $month, /** @scrutinizer ignore-type */ $this->dateTime->format('d'));
    }

    public function setDay(int $day): self
    {
        return $this->setDate($this->dateTime->format('Y'), $this->dateTime->format('m'), $day);
        return $this->setDate($this->dateTime->format('Y'), /** @scrutinizer ignore-type */ $this->dateTime->format('m'), $day);
    }

    public function setDate(int $year, int $month, int $day): self
    {
        $this->dateTime->setDate($year, $month, $day);

        return $this;
    }

    public static function min(...$dates): ?self
    {
        return \array_reduce($dates, function (?self $carry, self $dateTime) {
            if (!$carry || $dateTime->isBefore($carry)) {
                $carry = $dateTime;
            }

            return $carry;
        });
    }

    public static function max(...$dates): ?self
    {
        return \array_reduce($dates, function (?self $carry, self $dateTime) {
            if (!$carry || $dateTime->isAfter($carry)) {
                $carry = $dateTime;
            }

            return $carry;
        });
    }

    protected function getFormatFromTimePrecision(?string $precision): string
    {
        return DatePeriods::getDateFormat($precision ?? DatePeriods::DAY);
    }

    protected function getDateInterval(int $value, string $period): \DateInterval
    {
        try {
            $intervalCode = TimePeriods::getIntervalCode($period);
            $prefix       = 'PT';
        } catch (\InvalidArgumentException $e) {
            $intervalCode = DatePeriods::getIntervalCode($period);
            $prefix       = 'P';
        }

        return new \DateInterval("$prefix$value$intervalCode");
    }

    private function compareTo(self $date, string $operator, ?string $precision = null): bool
    {
        $format = $this->getFormatFromTimePrecision($precision);

        return \version_compare((int)$this->format($format), (int)$date->format($format), $operator);
    }

    protected function createInternalDateTime(string $time = 'now', $timezone = null)
    {
        if (\is_string($timezone)) {
            $timezone = new \DateTimeZone($timezone);
        }

        return new \DateTime($time, $timezone);
    }
}


palmtreephp / chrono

Push — master ( 26e9e8...850720 )

Date::add() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like