Hyde\Foundation\Concerns\ManagesHydeKernel

Complexity

Total Complexity

12

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Importance

Changes	10
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	3	1
A	setBasePath()	0	3	1
A	getSourceRoot()	0	3	1
A	setSourceRoot()	0	3	1
A	setInstance()	0	3	1
A	getBasePath()	0	3	1
A	registerPageClass()	0	20	5
A	getRegisteredPageClasses()	0	3	1

<?php

declare(strict_types=1);

namespace Hyde\Foundation\Concerns;

use BadMethodCallException;
use Hyde\Foundation\HydeKernel;
use Hyde\Pages\Concerns\HydePage;
use Hyde\Pages\Contracts\DynamicPage;
use function in_array;
use InvalidArgumentException;
use function is_subclass_of;

/**
 * @internal Single-use trait for the HydeKernel class.
 *
 * @see \Hyde\Foundation\HydeKernel
 */
trait ManagesHydeKernel
{
    public static function getInstance(): HydeKernel
    {
        return static::$instance;
    }

    public static function setInstance(HydeKernel $instance): void
    {
        static::$instance = $instance;

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

    }

    public function setBasePath(string $basePath): void
    {
        $this->basePath = rtrim($basePath, '/\\');

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

    }

    public function getBasePath(): string
    {
        return $this->basePath;
    }

    public function setSourceRoot(string $sourceRoot): void
    {
        $this->sourceRoot = rtrim($sourceRoot, '/\\');

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

    }

    public function getSourceRoot(): string
    {
        return $this->sourceRoot;
    }

    /**
     * Developer Information.
     *
     * @experimental This feature is experimental and may change substantially before the 1.0.0 release.
     *
     * If you are a package developer, and want a custom page class to be discovered,
     * you'll need to register it sometime before the boot process, before discovery is run.
     * Typically, you would do this by calling this method in the register method of a service provider.
     * Hyde will then automatically discover source files for the new page class, and compile them during the build process.
     *
     * @param  class-string<\Hyde\Pages\Concerns\HydePage>  $pageClass

The doc comment class-string<\Hyde\Pages\Concerns\HydePage> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<\Hyde\Pages\Concerns\HydePage>.

     */
    public function registerPageClass(string $pageClass): void
    {
        if ($this->booted) {
            // We throw an exception here to prevent the developer from registering a page class after the Kernel has been booted.
            // The reason we do this is because at this point all the source files have already been discovered and parsed.
            // If we allowed new classes after this point, we would have to reboot everything which adds complexity.

            throw new BadMethodCallException('Cannot register a page class after the Kernel has been booted.');
        }

        if (! is_subclass_of($pageClass, HydePage::class)) {
            throw new InvalidArgumentException('The specified class must be a subclass of HydePage.');
        }

        if (is_subclass_of($pageClass, DynamicPage::class)) {
            throw new InvalidArgumentException('The specified class must not be a subclass of DynamicPage.');
        }

        if (! in_array($pageClass, $this->pageClasses, true)) {
            $this->pageClasses[] = $pageClass;

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

        }
    }

    /** @return array<class-string<\Hyde\Pages\Concerns\HydePage>> */

The doc comment array<class-string<\Hyde\Pages\Concerns\HydePage>> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string<\Hyde\Pages\Concerns\HydePage>>.

    public function getRegisteredPageClasses(): array
    {
        return $this->pageClasses;
    }
}