Hyde\Framework\Models\Pages\DocumentationPage

Complexity

Total Complexity

8

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getOnlineSourcePath()	0	7	2
A	getTableOfContents()	0	3	1
A	__construct()	0	3	1
A	hasTableOfContents()	0	3	1
A	home()	0	3	2
A	getRouteKey()	0	3	1

<?php

namespace Hyde\Framework\Models\Pages;

use Hyde\Framework\Actions\GeneratesSidebarTableOfContents;
use Hyde\Framework\Concerns\AbstractMarkdownPage;
use Hyde\Framework\Contracts\FrontMatter\DocumentationPageSchema;
use Hyde\Framework\Contracts\RouteContract;
use Hyde\Framework\Models\FrontMatter;
use Hyde\Framework\Models\Markdown;
use Hyde\Framework\Models\Route;

class DocumentationPage extends AbstractMarkdownPage implements DocumentationPageSchema
{
    public static string $sourceDirectory = '_docs';
    public static string $outputDirectory = 'docs';
    public static string $template = 'hyde::layouts/docs';

    /** The sidebar category group, if any. Can be overridden in front matter, or by putting the source file in a subdirectory of the same category name. */
    public ?string $category = null;

    /** The label for the page shown in the sidebar. */
    public ?string $label = null;

    /** Hides the page from the sidebar. */
    public ?bool $hidden = null;

    /** The priority of the page used for ordering the sidebar. */
    public ?int $priority = null;

    /** @inheritDoc */
    public function __construct(string $identifier = '', ?FrontMatter $matter = null, ?Markdown $markdown = null)
    {
        parent::__construct($identifier, $matter, $markdown);
    }

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

    /** @internal */
    public function getOnlineSourcePath(): string|false
    {
        if (config('docs.source_file_location_base') === null) {
            return false;
        }

        return trim(config('docs.source_file_location_base'), '/').'/'.$this->identifier.'.md';
    }

    public static function home(): ?RouteContract
    {
        return Route::exists(static::$outputDirectory.'/index') ? Route::get(static::$outputDirectory.'/index') : null;
    }

    public static function hasTableOfContents(): bool
    {
        return config('docs.table_of_contents.enabled', true);
    }

    /**
     * Generate Table of Contents as HTML from a Markdown document body.
     */
    public function getTableOfContents(): string
    {
        return (new GeneratesSidebarTableOfContents($this->markdown))->execute();
    }
}