RouteKey::normalize() - Code Metrics - Inspection of "Merge pull request #1254 from hydephp/remove-depre..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 890a19...10d014 )

by Caen

created 2023-03-12 18:36 UTC

RouteKey::normalize() A

↳ Parent: RouteKey

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	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Hyde\Support\Models;

use Stringable;
use function unslash;

/**
 * Route keys provide the core bindings of the HydePHP routing system as they are what canonically identifies a page.
 * This class both provides a data object for normalized type-hintable values, and general related helper methods.
 *
 * In short, the route key is the URL path relative to the site webroot, without the file extension.
 *
 * For example, `_pages/index.blade.php` would be compiled to `_site/index.html` and thus has the route key of `index`.
 * As another example, `_posts/welcome.md` would be compiled to `_site/posts/welcome.html` and thus has the route key of `posts/welcome`.
 *
 * Note that if the source page's output directory is changed, the route key will change accordingly.
 * This can potentially cause links to break when changing the output directory for a page class.
 */
final class RouteKey implements Stringable
{
    protected readonly string $key;

    public static function make(string $key): self
    {
        return new self($key);
    }

    public function __construct(string $key)
    {
        $this->key = $key;

    }

    public function __toString(): string
    {
        return $this->key;
    }

    public function get(): string
    {
        return $this->key;
    }

    /** @param class-string<\Hyde\Pages\Concerns\HydePage> $pageClass */

    public static function fromPage(string $pageClass, string $identifier): self
    {
        return new self(unslash("{$pageClass::baseRouteKey()}/$identifier"));
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Hyde\Support\Models;
6
7			use Stringable;
8			use function unslash;
9
10			/**
11			* Route keys provide the core bindings of the HydePHP routing system as they are what canonically identifies a page.
12			* This class both provides a data object for normalized type-hintable values, and general related helper methods.
13			*
14			* In short, the route key is the URL path relative to the site webroot, without the file extension.
15			*
16			* For example, `_pages/index.blade.php` would be compiled to `_site/index.html` and thus has the route key of `index`.
17			* As another example, `_posts/welcome.md` would be compiled to `_site/posts/welcome.html` and thus has the route key of `posts/welcome`.
18			*
19			* Note that if the source page's output directory is changed, the route key will change accordingly.
20			* This can potentially cause links to break when changing the output directory for a page class.
21			*/
22			final class RouteKey implements Stringable
23			{
24			protected readonly string $key;
25
26			public static function make(string $key): self
27			{
28			return new self($key);
29			}
30
31			public function __construct(string $key)
32			{
33			$this->key = $key;
			0 ignored issues – show Bug introduced 2022-10-31 10:30 UTC by Report Bug Copy Issue Report The property `key` is declared read-only in `Hyde\Support\Models\RouteKey`. Loading history...
34			}
35
36			public function __toString(): string
37			{
38			return $this->key;
39			}
40
41			public function get(): string
42			{
43			return $this->key;
44			}
45
46			/** @param class-string<\Hyde\Pages\Concerns\HydePage> $pageClass */
			0 ignored issues – show Documentation Bug introduced 2023-01-05 11:26 UTC by Report Bug Copy Issue Report The doc comment `class-string<\Hyde\Pages\Concerns\HydePage>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<\Hyde\Pages\Concerns\HydePage>. Loading history...
47			public static function fromPage(string $pageClass, string $identifier): self
48			{
49			return new self(unslash("{$pageClass::baseRouteKey()}/$identifier"));
50			}
51			}
52

hydephp / develop

Push — master ( 890a19...10d014 )

RouteKey::normalize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like