Hyde\Framework\Concerns\FrontMatter\Schemas\Constructors\DocumentationPageSchemaConstructor

Complexity

Total Complexity

5

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	findPriorityInConfig()	0	9	2
A	getDocumentationPageCategory()	0	9	2
A	constructDocumentationPageSchema()	0	7	1

<?php

namespace Hyde\Framework\Concerns\FrontMatter\Schemas\Constructors;

use Hyde\Framework\Hyde;
use Illuminate\Support\Str;

trait DocumentationPageSchemaConstructor
{
    protected function constructDocumentationPageSchema(): void
    {
        $this->category = $this->getDocumentationPageCategory();

The property category does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->label = $this->matter('label', Hyde::makeTitle(basename($this->identifier)));

The property label does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

It seems like matter() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->hidden = $this->matter('hidden', $this->identifier === 'index');

The property hidden does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->priority = $this->matter('priority', $this->findPriorityInConfig());

The property priority does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    protected function getDocumentationPageCategory(): ?string
    {
        // If the documentation page is in a subdirectory,
        // then we can use that as the category name.
        // Otherwise, we look in the front matter.

        return str_contains($this->identifier, '/')
            ? Str::before($this->identifier, '/')
            : $this->matter('category', 'other');
    }

    protected function findPriorityInConfig(): int
    {
        $orderIndexArray = config('docs.sidebar_order', []);

        if (! in_array($this->identifier, $orderIndexArray)) {
            return 500;
        }

        return array_search($this->identifier, $orderIndexArray) + 250;

        // Adding 250 makes so that pages with a front matter priority that is lower
        // can be shown first. It's lower than the fallback of 500 so that they
        // still come first. This is all to make it easier to mix priorities.
    }
}