mimmi20/mezzio-navigation

<?php
/**
 * This file is part of the mimmi20/mezzio-navigation package.
 *
 * Copyright (c) 2020-2024, Thomas Mueller <mimmi20@live.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types = 1);

namespace Mimmi20\Mezzio\Navigation\Page;

use Closure;
use Mimmi20\Mezzio\Navigation\Exception;

use function assert;
use function call_user_func;
use function class_exists;
use function is_string;
use function mb_strtolower;
use function sprintf;

/**
 * Base class for Mimmi20\Mezzio\Navigation\Page pages
 */
final class PageFactory implements PageFactoryInterface
{
    /**
     * Static factories list for factory pages
     *
     * @var array<(Closure(array<string, array<string>|bool|string>): ?PageInterface)>
     */
    private static array $factories = [];

    /**
     * Factory for Mimmi20\Mezzio\Navigation\Page classes
     * A specific type to construct can be specified by specifying the key
     * 'type' in $options. If type is 'uri' or 'route', the type will be resolved
     * to Mimmi20\Mezzio\Navigation\Page\Uri or Mimmi20\Mezzio\Navigation\Page\Route. Any other value
     * for 'type' will be considered the full name of the class to construct.
     * A valid custom page class must extend Mimmi20\Mezzio\Navigation\Page\AbstractPage.
     * If 'type' is not given, the type of page to construct will be determined
     * by the following rules:
     * - If $options contains the key 'route', a Mimmi20\Mezzio\Navigation\Page\Route page will be created.
     * - If $options contains the key 'uri', a Mimmi20\Mezzio\Navigation\Page\Uri page will be created.
     *
     * @param array<string, array<string>|bool|string> $options options used for creating page
     *
     * @return PageInterface a page instance
     *
     * @throws Exception\InvalidArgumentException
     */
    public function factory(array $options): PageInterface
    {
        if (isset($options['type'])) {
            $type = $options['type'];

            unset($options['type']);

            if (is_string($type) && $type !== '') {
                switch (mb_strtolower($type)) {
                    case 'route':
                        $type = Route::class;

                        break;
                    case 'uri':
                        $type = Uri::class;

                        break;
                }

                if (!class_exists($type, true)) {
                    throw new Exception\InvalidArgumentException('Cannot find class ' . $type);
                }

                $page = new $type($options);

                if (!$page instanceof PageInterface) {
                    throw new Exception\InvalidArgumentException(
                        sprintf(
                            'Invalid argument: Detected type "%s", which is not an instance of %s',
                            $type,
                            PageInterface::class,
                        ),
                    );
                }

                return $page;
            }
        }

        foreach (self::$factories as $factoryCallBack) {
            $page = call_user_func($factoryCallBack, $options);

            if ($page) {
                assert($page instanceof PageInterface);

                return $page;
            }
        }

        $hasUri   = isset($options['uri']);
        $hasRoute = isset($options['route']);

        if ($hasRoute) {
            return new Route($options);
        }

        if ($hasUri) {
            return new Uri($options);
        }

        throw new Exception\InvalidArgumentException(
            'Invalid argument: Unable to determine class to instantiate',
        );
    }

    /**
     * Add static factory for self::factory function
     *
     * @param (Closure(array<string, array<string>|bool|string>): ?PageInterface) $callback Any callable variable
     *
     * @throws void
     *
     * @api
     */
    public static function addFactory(Closure $callback): void
    {
        self::$factories[] = $callback;
    }
}