OpenConext / Stepup-SelfService

src/Surfnet/StepupSelfService/SelfServiceBundle/Value/DateTime.php

<?php

declare(strict_types = 1);

/**
 * Copyright 2016 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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Value;

use DateInterval;
use DateTime as CoreDateTime;
use Surfnet\StepupSelfService\SelfServiceBundle\Exception\InvalidArgumentException;
use Stringable;

/**

Missing short description in doc comment

 * @SuppressWarnings(PHPMD.TooManyPublicMethods) due to comparison methods
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class DateTime implements Stringable
{
    /**
     * This string can also be used with `DateTime::createFromString()`.
     */
    final public const FORMAT = DATE_ATOM;

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

Private member variable "now" must be prefixed with an underscore

    private readonly CoreDateTime $dateTime;

Private member variable "dateTime" must be prefixed with an underscore

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $string A date-time string formatted using `self::FORMAT` (eg. '2014-11-26T15:20:43+01:00').

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return DateTime

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function fromString($string): self
    {
        if (!is_string($string)) {

The condition is_string($string) is always true.

            InvalidArgumentException::invalidType('string', 'string', $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);
    }

    /**

Missing short description in doc comment

     * @param CoreDateTime|null $dateTime

Missing parameter comment

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

The property dateTime is declared read-only in Surfnet\StepupSelfService\SelfServiceBundle\Value\DateTime.

    }

    /**

Missing short description in doc comment

Parameter $interval should have a doc-comment as per coding-style.

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

        return new self($dateTime);
    }

    /**

Missing short description in doc comment

Parameter $interval should have a doc-comment as per coding-style.

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

        return new self($dateTime);
    }

    /**

Missing short description in doc comment

Parameter $dateTime should have a doc-comment as per coding-style.

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

    /**

Missing short description in doc comment

Parameter $dateTime should have a doc-comment as per coding-style.

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

    /**

Missing short description in doc comment

Parameter $dateTime should have a doc-comment as per coding-style.

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

    /**

Missing short description in doc comment

Parameter $dateTime should have a doc-comment as per coding-style.

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

    /**

Missing short description in doc comment

     * @param $format

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    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;
    }

    /**

Missing short description in doc comment

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