Hyde\Framework\Contracts\AbstractPage

Complexity

Total Complexity

21

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getOutputPath()	0	3	1
A	getFileExtension()	0	3	1
A	getOutputLocation()	0	7	1
A	htmlTitle()	0	7	2
A	getCurrentPagePath()	0	3	1
A	getRoute()	0	3	1
A	__get()	0	3	1
A	getSourcePath()	0	3	1
A	__set()	0	3	1
A	qualifyBasename()	0	3	1
A	getOutputDirectory()	0	3	1
A	files()	0	3	1
A	parse()	0	3	1
A	__construct()	0	4	2
A	getSourceDirectory()	0	3	1
A	getBladeView()	0	3	1
A	matter()	0	3	1
A	all()	0	9	2

<?php

namespace Hyde\Framework\Contracts;

use Hyde\Framework\Actions\SourceFileParser;
use Hyde\Framework\Concerns\CanBeInNavigation;
use Hyde\Framework\Concerns\HasPageMetadata;
use Hyde\Framework\Models\FrontMatter;
use Hyde\Framework\Models\Route;
use Hyde\Framework\Services\DiscoveryService;
use Illuminate\Support\Collection;

/**
 * To ensure compatibility with the Hyde Framework, all Page Models should extend this class.
 *
 * Markdown-based Pages can extend the AbstractMarkdownPage class to get relevant helpers.
 *
 * To learn about what the methods do, see the PHPDocs in the PageContract.
 *
 * @see \Hyde\Framework\Contracts\PageContract
 * @see \Hyde\Framework\Contracts\AbstractMarkdownPage
 * @test \Hyde\Framework\Testing\Feature\AbstractPageTest
 */
abstract class AbstractPage implements PageContract, CompilableContract
{
    use HasPageMetadata;

The trait Hyde\Framework\Concerns\HasPageMetadata requires the property $title which is not provided by Hyde\Framework\Contracts\AbstractPage.

    use CanBeInNavigation;

The trait Hyde\Framework\Concerns\CanBeInNavigation requires the property $title which is not provided by Hyde\Framework\Contracts\AbstractPage.

    public static string $sourceDirectory;
    public static string $outputDirectory;
    public static string $fileExtension;
    public static string $template;

    public string $identifier;
    public FrontMatter $matter;

    /** @inheritDoc */
    final public static function getSourceDirectory(): string
    {
        return unslash(static::$sourceDirectory);
    }

    /** @inheritDoc */
    final public static function getOutputDirectory(): string
    {
        return unslash(static::$outputDirectory);
    }

    /** @inheritDoc */
    final public static function getFileExtension(): string
    {
        return '.'.ltrim(static::$fileExtension, '.');
    }

    /** @inheritDoc */
    public static function parse(string $slug): PageContract
    {
        return (new SourceFileParser(static::class, $slug))->get();
    }

    /** @inheritDoc */
    public static function files(): array|false
    {
        return DiscoveryService::getSourceFileListForModel(static::class);
    }

    /** @inheritDoc */
    public static function all(): Collection
    {
        $collection = new Collection();

        foreach (static::files() as $basename) {
            $collection->push(static::parse($basename));
        }

        return $collection;
    }

    /** @inheritDoc */
    public static function qualifyBasename(string $basename): string
    {
        return static::getSourceDirectory().'/'.unslash($basename).static::getFileExtension();
    }

    /** @inheritDoc */
    public static function getOutputLocation(string $basename): string
    {
        // Using the trim function we ensure we don't have a leading slash when the output directory is the root directory.
        return trim(
            static::getOutputDirectory().'/'.unslash($basename),
            '/'
        ).'.html';
    }

    public function __construct(string $identifier = '', FrontMatter|array $matter = [])
    {
        $this->identifier = $identifier;
        $this->matter = $matter instanceof FrontMatter ? $matter : new FrontMatter($matter);

$matter is never a sub-type of Hyde\Framework\Models\FrontMatter.

    }

    /** @interitDoc */
    public function __get(string $name)
    {
        return $this->matter->get($name);
    }

    /** @inheritDoc */
    public function __set(string $name, $value): void
    {
        $this->matter->set($name, $value);
    }

    /** @inheritDoc */
    public function matter(string $key = null, mixed $default = null): mixed
    {
        return $this->matter->get($key, $default);
    }

    /** @inheritDoc */
    public function getSourcePath(): string
    {
        return static::qualifyBasename($this->identifier);
    }

    /** @inheritDoc */
    public function getOutputPath(): string
    {
        return static::getCurrentPagePath().'.html';

The method Hyde\Framework\Contracts\AbstractPage::getCurrentPagePath() is not static, but was called statically.

    }

    /** @inheritDoc */
    public function getCurrentPagePath(): string
    {
        return trim(static::getOutputDirectory().'/'.$this->identifier, '/');
    }

    /** @inheritDoc */
    public function getRoute(): Route
    {
        return new Route($this);
    }

    /** @inheritDoc */
    public function htmlTitle(?string $title = null): string
    {
        $pageTitle = $title ?? $this->title ?? null;

The property title does not exist on Hyde\Framework\Contracts\AbstractPage. Since you implemented __get, consider adding a @property annotation.

        return $pageTitle
            ? config('site.name', 'HydePHP').' - '.$pageTitle
            : config('site.name', 'HydePHP');
    }

    /** @inheritDoc */
    public function getBladeView(): string
    {
        return static::$template;
    }

    /** @inheritDoc */
    abstract public function compile(): string;
}