Hyde\Framework\Features\Documentation\DocumentationSearchPage

Complexity

Total Complexity

6

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Importance

Changes	9
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	compile()	0	3	1
A	generate()	0	3	1
A	routeKey()	0	3	1
A	enabled()	0	3	2

<?php

declare(strict_types=1);

namespace Hyde\Framework\Features\Documentation;

use Hyde\Framework\Actions\StaticPageBuilder;
use Hyde\Hyde;
use Hyde\Pages\DocumentationPage;

/**
 * @internal This page is used to render the search page for the documentation.
 *
 * It is not based on a source file, but is dynamically generated when the Search feature is enabled.
 * If you want to override this page, you can create a page with the route key "docs/search",
 * then this class will not be applied. For example, `_pages/docs/search.blade.php`.
 *
 * @see \Hyde\Framework\Testing\Feature\DocumentationSearchPageTest
 */
class DocumentationSearchPage extends DocumentationPage
{
    public function __construct()
    {
        parent::__construct('search', [
            'title' => 'Search',
        ]);
    }

    public function compile(): string
    {
        return view('hyde::pages.documentation-search')->render();
    }

    public static function enabled(): bool
    {
        return config('docs.create_search_page', true) && ! Hyde::routes()->has(self::routeKey());
    }

    public static function generate(): string
    {
        return (new StaticPageBuilder(new static()))->__invoke();
    }

    public static function routeKey(): string
    {
        return parent::$outputDirectory.'/search';
    }
}