Hyde\Pages\DocumentationPage

Complexity

Total Complexity

5

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Importance

Changes	4
Bugs	1	Features	0

4 Methods

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

<?php

declare(strict_types=1);

namespace Hyde\Pages;

use Hyde\Framework\Actions\GeneratesSidebarTableOfContents;
use Hyde\Markdown\Contracts\FrontMatter\DocumentationPageSchema;
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 implements DocumentationPageSchema

The interface Hyde\Markdown\Contracts\FrontMatter\DocumentationPageSchema has been deprecated: The navigation is inherited by the parent page, and the category is not documented, thus presumed to be unused.

{
    use Concerns\UsesFlattenedOutputPaths;

    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::$outputDirectory.'/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(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();
    }
}