Hyde\Support\Models\RouteKey

Complexity

Total Complexity

5

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	get()	0	3	1
A	make()	0	3	1
A	__construct()	0	3	1
A	fromPage()	0	3	1

<?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;

The property key is declared read-only in Hyde\Support\Models\RouteKey.

    }

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

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

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

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>.

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