Hyde\Pages\DocumentationPage

Complexity

Total Complexity

10

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

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

<?php

declare(strict_types=1);

namespace Hyde\Pages;

use Hyde\Facades\Config;
use Hyde\Framework\Actions\GeneratesSidebarTableOfContents;
use Hyde\Pages\Concerns\BaseMarkdownPage;
use Hyde\Support\Models\Route;

/**
 * Page class for documentation pages.
 *
 * Documentation pages are stored in the _docs directory and using the .md extension.
 * The Markdown will be compiled to HTML using the documentation page layout to the _site/docs/ directory.
 *
 * @see https://hydephp.com/docs/master/documentation-pages
 */
class DocumentationPage extends BaseMarkdownPage
{
    public static string $sourceDirectory = '_docs';
    public static string $outputDirectory = 'docs';
    public static string $template = 'hyde::layouts/docs';

    public static function home(): ?Route
    {
        return Route::get(static::homeRouteName());
    }

    public static function homeRouteName(): string
    {
        return static::baseRouteKey().'/index';
    }

    /** @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button */
    public function getOnlineSourcePath(): string|false
    {
        if (config('docs.source_file_location_base') === null) {
            return false;
        }

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

    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();
    }

    /**
     * Get the route key for the page.
     *
     * If flattened outputs are enabled, this will use the identifier basename so nested pages are flattened.
     */
    public function getRouteKey(): string
    {
        return Config::getBool('docs.flattened_output_paths', true)
            ? unslash(static::outputDirectory().'/'.basename($this->identifier))
            : parent::getRouteKey();
    }

    /**
     * Get the path where the compiled page will be saved.
     *
     * If flattened outputs are enabled, this will use the identifier basename so nested pages are flattened.
     */
    public function getOutputPath(): string
    {
        return Config::getBool('docs.flattened_output_paths', true)
            ? static::outputPath(basename($this->identifier))
            : parent::getOutputPath();
    }
}