zenstruck / schedule-bundle

src/Schedule/RunContext.php

<?php

namespace Zenstruck\ScheduleBundle\Schedule;

use Symfony\Component\Console\Helper\Helper;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
abstract class RunContext
{
    /** @var \DateTimeImmutable */
    private $startTime;

    /** @var int|null */
    private $duration;

    /** @var int|null */
    private $memory;

    public function __construct()
    {
        $this->startTime = new \DateTimeImmutable('now');
    }

    abstract public function __toString(): string;

    final public function getStartTime(): \DateTimeImmutable
    {
        return $this->startTime;
    }

    final public function hasRun(): bool
    {
        return null !== $this->memory;
    }

    final public function getDuration(): int
    {
        $this->ensureHasRun();

        return $this->duration;

The expression return $this->duration could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    final public function getFormattedDuration(): string
    {
        return Helper::formatTime($this->getDuration());

The expression return Symfony\Component\Console\Helper\Helper::formatTime($this->getDuration()) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    final public function getMemory(): int
    {
        $this->ensureHasRun();

        return $this->memory;

The expression return $this->memory could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    final public function getFormattedMemory(): string
    {
        return Helper::formatMemory($this->getMemory());
    }

    final protected function markAsRun(int $memory): void
    {
        $this->duration = \time() - $this->getStartTime()->getTimestamp();
        $this->memory = $memory;
    }

    /**
     * @throws \LogicException if has not yet run
     */
    final protected function ensureHasRun(): void
    {
        if (!$this->hasRun()) {
            throw new \LogicException("\"{$this}\" has not yet run.");
        }
    }
}