RunContext::markAsRun() - Code Metrics - zenstruck/schedule-bundle - Measure and Improve Code Quality continuously with Scrutinizer

RunContext::markAsRun() A
last analyzed 2022-02-21 22:53 UTC

↳ Parent: RunContext

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Zenstruck\ScheduleBundle\Schedule;

use Symfony\Component\Console\Helper\Helper;

/**
 * @author Kevin Bond <[email protected]>
 */
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;

    }

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

    }

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

        return $this->memory;

    }

    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.");
        }
    }
}


1		<?php
2
3		namespace Zenstruck\ScheduleBundle\Schedule;
4
5		use Symfony\Component\Console\Helper\Helper;
6
7		/**
8		* @author Kevin Bond <[email protected]>
9		*/
10		abstract class RunContext
11		{
12		/** @var \DateTimeImmutable */
13		private $startTime;
14
15		/** @var int\|null */
16	88	private $duration;
17
18	88	/** @var int\|null */
19	88	private $memory;
20
21		public function __construct()
22		{
23	88	$this->startTime = new \DateTimeImmutable('now');
24		}
25	88
26		abstract public function __toString(): string;
27
28	78	final public function getStartTime(): \DateTimeImmutable
29		{
30	78	return $this->startTime;
31		}
32
33	13	final public function hasRun(): bool
34		{
35	13	return null !== $this->memory;
36		}
37	13
38		final public function getDuration(): int
39		{
40	13	$this->ensureHasRun();
41
42	13	return $this->duration;
		0 ignored issues – show Bug Best Practice introduced 2022-02-16 15:06 UTC by Report Bug Copy Issue Report 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. Loading history...
43		}
44
45	13	final public function getFormattedDuration(): string
46		{
47	13	return Helper::formatTime($this->getDuration());
		0 ignored issues – show Bug Best Practice introduced 2020-01-21 22:47 UTC by Report Bug Copy Issue Report The expression `return Symfony\Component...e($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. Loading history...
48		}
49	13
50		final public function getMemory(): int
51		{
52	13	$this->ensureHasRun();
53
54	13	return $this->memory;
		0 ignored issues – show Bug Best Practice introduced 2022-02-16 15:06 UTC by Report Bug Copy Issue Report 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. Loading history...
55		}
56
57	73	final public function getFormattedMemory(): string
58		{
59	73	return Helper::formatMemory($this->getMemory());
60	73	}
61	73
62		final protected function markAsRun(int $memory): void
63		{
64		$this->duration = \time() - $this->getStartTime()->getTimestamp();
65		$this->memory = $memory;
66	74	}
67
68	74	/**
69	2	* @throws \LogicException if has not yet run
70		*/
71	72	final protected function ensureHasRun(): void
72		{
73		if (!$this->hasRun()) {
74		throw new \LogicException("\"{$this}\" has not yet run.");
75		}
76		}
77		}
78

zenstruck / schedule-bundle

RunContext::markAsRun() A last analyzed 2022-02-21 22:53 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RunContext::markAsRun() A
last analyzed 2022-02-21 22:53 UTC