Cycle\Migrations\Migration\State

Complexity

Total Complexity

6

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getTimeCreated()	0	3	1
A	withStatus()	0	7	1
A	getTimeExecuted()	0	3	1
A	__construct()	0	10	1
A	getStatus()	0	3	1
A	getName()	0	3	1

<?php

/**
 * Spiral Framework.
 *
 * @license MIT
 * @author  Anton Titov (Wolfy-J)
 */

declare(strict_types=1);

namespace Cycle\Migrations\Migration;

/**
 * Migration meta information specific to current environment.
 *
 * @psalm-import-type StatusEnum from Status
 *
 * @internal State is an internal library class, please do not use it in your code.
 * @psalm-internal Cycle\Migrations
 */
class State
{
    /**
     * @var non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    private $name;

    /**
     * @var StatusEnum

The type Cycle\Migrations\Migration\StatusEnum was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    private $status;

    /**
     * @var \DateTimeInterface
     */
    private $createdAt;

    /**
     * @var \DateTimeInterface|null
     */
    private $executedAt;

    /**
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param \DateTimeInterface $createdAt
     * @param StatusEnum $status
     * @param \DateTimeInterface|null $executedAt
     */
    public function __construct(
        string $name,
        \DateTimeInterface $createdAt,
        int $status = Status::STATUS_UNDEFINED,
        \DateTimeInterface $executedAt = null
    ) {
        $this->name = $name;
        $this->status = $status;

It seems like $status can also be of type integer. However, the property $status is declared as type Cycle\Migrations\Migration\StatusEnum. Maybe add an additional type check?

        $this->createdAt = $createdAt;
        $this->executedAt = $executedAt;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Migration status.
     *
     * @return int
     */
    public function getStatus(): int
    {
        return $this->status;

The expression return $this->status returns the type Cycle\Migrations\Migration\StatusEnum which is incompatible with the type-hinted return integer.

    }

    /**
     * Get migration creation time.
     *
     * @return \DateTimeInterface
     */
    public function getTimeCreated(): \DateTimeInterface
    {
        return $this->createdAt;
    }

    /**
     * Get migration execution time if any.
     *
     * @return \DateTimeInterface|null
     */
    public function getTimeExecuted(): ?\DateTimeInterface
    {
        return $this->executedAt;
    }

    /**
     * @param StatusEnum $status
     * @param \DateTimeInterface|null $executedAt
     * @return State
     */
    public function withStatus(int $status, \DateTimeInterface $executedAt = null): State
    {
        $state = clone $this;
        $state->status = $status;

It seems like $status of type integer is incompatible with the declared type Cycle\Migrations\Migration\StatusEnum of property $status.

        $state->executedAt = $executedAt;

        return $state;
    }
}