Hyde\Foundation\Concerns\ManagesExtensions

Complexity

Total Complexity

6

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getRegisteredExtensions()	0	3	1
A	registerExtension()	0	19	4
A	getRegisteredPageClasses()	0	6	1

<?php

declare(strict_types=1);

namespace Hyde\Foundation\Concerns;

use BadMethodCallException;
use InvalidArgumentException;
use function array_map;
use function array_merge;
use function array_unique;
use function in_array;
use function is_subclass_of;

/**
 * @internal Single-use trait for the HydeKernel class.
 *
 * @see \Hyde\Foundation\HydeKernel
 */
trait ManagesExtensions
{
    /**
     * Register a HydePHP extension within the HydeKernel.
     *
     * Typically, you would call this method in the register method of a service provider.
     * If your package uses the standard Laravel (Composer) package discovery feature,
     * the extension will automatically be enabled when the package is installed.
     *
     * @param  class-string<\Hyde\Foundation\Concerns\HydeExtension>  $extension

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

     */
    public function registerExtension(string $extension): void
    {
        if ($this->booted) {
            // We throw an exception here to prevent the developer from registering aa extension 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 an extension after the Kernel has been booted.');
        }

        if (! is_subclass_of($extension, HydeExtension::class)) {
            // We want to make sure that the extension class extends the HydeExtension class,
            // so that we won't have to check the methods we need to call exist later on.

            throw new InvalidArgumentException('The specified class must extend the HydeExtension class.');
        }

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

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

        }
    }

    /** @return array<class-string<\Hyde\Foundation\Concerns\HydeExtension>> */

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

    public function getRegisteredExtensions(): array
    {
        return $this->extensions;
    }

    /** @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 array_unique(array_merge(...array_map(function (string $extension): array {
            /** @var <class-string<\Hyde\Foundation\Concerns\HydeExtension>> $extension */
            return $extension::getPageClasses();
        }, $this->getRegisteredExtensions())));
    }
}