DebugRoute::getName() - Code Metrics - Inspection of "Updated routing and fixed tests" - divineniiquaye/flight-routing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d0f9e3...c3e906 )

by Divine Niiquaye

created 2020-11-27 22:01 UTC

DebugRoute::getName() A

↳ Parent: DebugRoute

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of Flight Routing.
 *
 * PHP version 7.1 and above required
 *
 * @author    Divine Niiquaye Ibok <[email protected]>
 * @copyright 2019 Biurad Group (https://biurad.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Flight\Routing;

use ArrayIterator;
use Flight\Routing\Interfaces\RouteInterface;
use IteratorAggregate;
use Traversable;

/**
 * @author Divine Niiquaye Ibok <[email protected]>
 */
final class DebugRoute implements IteratorAggregate
{
    /** @var null|RouteInterface */
    private $route;

    /** @var string */
    private $name;

    /** @var bool */
    private $matched = false;

    /** @var array<string,float|int> */
    private $starts = [];

    /** @var array<string,float|int> */
    private $ends = [];

    /** @var DebugRoute[] */
    private $profiles = [];

    public function __construct(string $name = 'main', ?RouteInterface $route = null)
    {
        $this->route = $route;
        $this->name  = $name;
        $this->enter();
    }

    /**
     * Add Matched info of route
     *
     * @param string $name
     * @param bool   $matched
     */
    public function setMatched(string $name, bool $matched = true): void
    {
        if (!empty($this->profiles)) {
            foreach ($this->profiles as $profile) {
                if ($name === $profile->getName()) {
                    $profile->matched = $matched;
                }
            }

            return;
        }

        if ($name === $this->name) {
            $this->matched = $matched;
        }
    }

    /**
     * @return null|RouteInterface
     */
    public function getRoute(): ?RouteInterface
    {
        return $this->route;
    }

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

    /**
     * @return bool
     */
    public function isRoute(): bool
    {
        return $this->route instanceof RouteInterface;
    }

    /**
     * @return bool
     */
    public function isMatched(): bool
    {
        return $this->matched;
    }

    /**
     * @return ProfileRoute[]
     */
    public function getProfiles(): array
    {
        return $this->profiles;

    }

    /**
     * Add a new profiled route
     *
     * @param ProfileRoute $profile
filter:
    dependency_paths: ["lib/*"]
     */
    public function addProfile(self $profile): void
    {
        $this->profiles[] = $profile;
    }

    /**
     * Returns the duration in microseconds.
     *
     * @return float
     */
    public function getDuration(): float
    {
        if (!empty($this->profiles)) {
            // for the root node with children, duration is the sum of all child durations
            $duration = 0;

            foreach ($this->profiles as $profile) {
                $duration += $profile->getDuration();
            }

            return $duration;
        }

        return isset($this->ends['wt']) && isset($this->starts['wt']) ? $this->ends['wt'] - $this->starts['wt'] : 0;
    }

    /**
     * Returns the memory usage in bytes.
     *
     * @return int|float
     */
    public function getMemoryUsage()
    {
        return isset($this->ends['mu']) && isset($this->starts['mu']) ? $this->ends['mu'] - $this->starts['mu'] : 0;
    }

    /**
     * Returns the peak memory usage in bytes.
     *
     * @return int|float
     */
    public function getPeakMemoryUsage()
    {
        return isset($this->ends['pmu']) && isset($this->starts['pmu']) ? $this->ends['pmu'] - $this->starts['pmu'] : 0;
    }

    /**
     * Starts the profiling.
     */
    public function enter(): void
    {
        $this->starts = [
            'wt'  => \microtime(true),
            'mu'  => \memory_get_usage(),
            'pmu' => \memory_get_peak_usage(),
        ];
    }

    /**
     * Stops the profiling.
     */
    public function leave(): void
    {
        $this->ends = [
            'wt'  => \microtime(true),
            'mu'  => \memory_get_usage(),
            'pmu' => \memory_get_peak_usage(),
        ];
    }

    public function reset(): void
    {
        $this->starts = $this->ends = $this->profiles = [];
        $this->enter();
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): Traversable
    {
        return new ArrayIterator($this->profiles);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of Flight Routing.
7			*
8			* PHP version 7.1 and above required
9			*
10			* @author Divine Niiquaye Ibok <[email protected]>
11			* @copyright 2019 Biurad Group (https://biurad.com/)
12			* @license https://opensource.org/licenses/BSD-3-Clause License
13			*
14			* For the full copyright and license information, please view the LICENSE
15			* file that was distributed with this source code.
16			*/
17
18			namespace Flight\Routing;
19
20			use ArrayIterator;
21			use Flight\Routing\Interfaces\RouteInterface;
22			use IteratorAggregate;
23			use Traversable;
24
25			/**
26			* @author Divine Niiquaye Ibok <[email protected]>
27			*/
28			final class DebugRoute implements IteratorAggregate
29			{
30			/** @var null\|RouteInterface */
31			private $route;
32
33			/** @var string */
34			private $name;
35
36			/** @var bool */
37			private $matched = false;
38
39			/** @var array<string,float\|int> */
40			private $starts = [];
41
42			/** @var array<string,float\|int> */
43			private $ends = [];
44
45			/** @var DebugRoute[] */
46			private $profiles = [];
47
48			public function __construct(string $name = 'main', ?RouteInterface $route = null)
49			{
50			$this->route = $route;
51			$this->name = $name;
52			$this->enter();
53			}
54
55			/**
56			* Add Matched info of route
57			*
58			* @param string $name
59			* @param bool $matched
60			*/
61			public function setMatched(string $name, bool $matched = true): void
62			{
63			if (!empty($this->profiles)) {
64			foreach ($this->profiles as $profile) {
65			if ($name === $profile->getName()) {
66			$profile->matched = $matched;
67			}
68			}
69
70			return;
71			}
72
73			if ($name === $this->name) {
74			$this->matched = $matched;
75			}
76			}
77
78			/**
79			* @return null\|RouteInterface
80			*/
81			public function getRoute(): ?RouteInterface
82			{
83			return $this->route;
84			}
85
86			/**
87			* @return string
88			*/
89			public function getName(): string
90			{
91			return $this->name;
92			}
93
94			/**
95			* @return bool
96			*/
97			public function isRoute(): bool
98			{
99			return $this->route instanceof RouteInterface;
100			}
101
102			/**
103			* @return bool
104			*/
105			public function isMatched(): bool
106			{
107			return $this->matched;
108			}
109
110			/**
111			* @return ProfileRoute[]
112			*/
113			public function getProfiles(): array
114			{
115			return $this->profiles;
			0 ignored issues – show Bug Best Practice introduced 2020-11-27 22:09 UTC by Report Bug Copy Issue Report The expression `return $this->profiles` returns the type `Flight\Routing\DebugRoute[]` which is incompatible with the documented return type `Flight\Routing\ProfileRoute[]`. Loading history...
116			}
117
118			/**
119			* Add a new profiled route
120			*
121			* @param ProfileRoute $profile
			0 ignored issues – show Bug introduced 2020-11-27 22:09 UTC by Report Bug Copy Issue Report The type `Flight\Routing\ProfileRoute` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
122			*/
123			public function addProfile(self $profile): void
124			{
125			$this->profiles[] = $profile;
126			}
127
128			/**
129			* Returns the duration in microseconds.
130			*
131			* @return float
132			*/
133			public function getDuration(): float
134			{
135			if (!empty($this->profiles)) {
136			// for the root node with children, duration is the sum of all child durations
137			$duration = 0;
138
139			foreach ($this->profiles as $profile) {
140			$duration += $profile->getDuration();
141			}
142
143			return $duration;
144			}
145
146			return isset($this->ends['wt']) && isset($this->starts['wt']) ? $this->ends['wt'] - $this->starts['wt'] : 0;
147			}
148
149			/**
150			* Returns the memory usage in bytes.
151			*
152			* @return int\|float
153			*/
154			public function getMemoryUsage()
155			{
156			return isset($this->ends['mu']) && isset($this->starts['mu']) ? $this->ends['mu'] - $this->starts['mu'] : 0;
157			}
158
159			/**
160			* Returns the peak memory usage in bytes.
161			*
162			* @return int\|float
163			*/
164			public function getPeakMemoryUsage()
165			{
166			return isset($this->ends['pmu']) && isset($this->starts['pmu']) ? $this->ends['pmu'] - $this->starts['pmu'] : 0;
167			}
168
169			/**
170			* Starts the profiling.
171			*/
172			public function enter(): void
173			{
174			$this->starts = [
175			'wt' => \microtime(true),
176			'mu' => \memory_get_usage(),
177			'pmu' => \memory_get_peak_usage(),
178			];
179			}
180
181			/**
182			* Stops the profiling.
183			*/
184			public function leave(): void
185			{
186			$this->ends = [
187			'wt' => \microtime(true),
188			'mu' => \memory_get_usage(),
189			'pmu' => \memory_get_peak_usage(),
190			];
191			}
192
193			public function reset(): void
194			{
195			$this->starts = $this->ends = $this->profiles = [];
196			$this->enter();
197			}
198
199			/**
200			* {@inheritdoc}
201			*/
202			public function getIterator(): Traversable
203			{
204			return new ArrayIterator($this->profiles);
205			}
206			}
207

divineniiquaye / flight-routing

Push — master ( d0f9e3...c3e906 )

DebugRoute::getName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like