BakePlugin.php

<?php
declare(strict_types=1);

/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         1.7.2
 * @license       https://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Bake;

use Bake\Command\BakeCommand;
use Bake\Command\EntryCommand;
use Cake\Console\CommandCollection;
use Cake\Core\BasePlugin;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Core\PluginApplicationInterface;
use Cake\Http\BaseApplication;
use DirectoryIterator;
use ReflectionClass;

/**
 * Plugin class for bake
 */
class BakePlugin extends BasePlugin
{
    /**
     * Plugin name.
     */
    protected ?string $name = 'Bake';

    /**
     * Load routes or not
     */
    protected bool $routesEnabled = false;

    /**
     * Load the TwigView plugin.
     *
     * @param \Cake\Core\PluginApplicationInterface $app The host application
     * @return void
     */
    public function bootstrap(PluginApplicationInterface $app): void
    {
        assert($app instanceof BaseApplication);

        if (!$app->getPlugins()->has('Cake/TwigView')) {
            $app->addPlugin('Cake/TwigView');
        }
    }

    /**
     * Define the console commands for an application.
     *
     * @param \Cake\Console\CommandCollection $commands The CommandCollection to add commands into.
     * @return \Cake\Console\CommandCollection The updated collection.
     */
    public function console(CommandCollection $commands): CommandCollection
    {
        // Add commands in plugins and app.
        $commands = $this->discoverCommands($commands);

        // Add entry command to handle entry point and backwards compat.
        $commands->add(EntryCommand::defaultName(), EntryCommand::class);

        return $commands;
    }

    /**
     * Scan plugins and application to find commands that are intended
     * to be used with bake.
     *
     * Non-Abstract commands extending `Bake\Command\BakeCommand` are included.
     * Plugins are scanned in the order they are listed in `Plugin::loaded()`
     *
     * @param \Cake\Console\CommandCollection $commands The CommandCollection to add commands into.
     * @return \Cake\Console\CommandCollection The updated collection.
     */
    protected function discoverCommands(CommandCollection $commands): CommandCollection
    {
        foreach (Plugin::getCollection()->with('console') as $plugin) {
            $namespace = str_replace('/', '\\', $plugin->getName());
            $pluginPath = $plugin->getClassPath();

            $found = $this->findInPath($namespace, $pluginPath);
            if ($found !== []) {
                $commands->addMany($found);
            }
        }

        $found = $this->findInPath(Configure::read('App.namespace'), APP);
        if ($found !== []) {
            $commands->addMany($found);
        }

        return $commands;
    }

    /**
     * Search a path for commands.
     *
     * @param string $namespace The namespace classes are expected to be in.
     * @param string $path The path to look in.
     * @return array<string>
     * @phpstan-return array<string, class-string<\Bake\Command\BakeCommand>>
     */
    protected function findInPath(string $namespace, string $path): array
    {
        $hasSubfolder = false;
        $path .= 'Command/';
        $namespace .= '\Command\\';

        if (file_exists($path . 'Bake/')) {
            $hasSubfolder = true;
            $path .= 'Bake/';
            $namespace .= 'Bake\\';
        } elseif (!file_exists($path)) {
            return [];
        }

        $iterator = new DirectoryIterator($path);
        $candidates = [];
        foreach ($iterator as $item) {
            if ($item->isDot() || $item->isDir()) {
                continue;
            }
            $class = $namespace . $item->getBasename('.php');

            if (!$hasSubfolder) {
                if (!class_exists($class)) {
                    continue;
                }

                $reflection = new ReflectionClass($class);
                if (!$reflection->isInstantiable() || !$reflection->isSubclassOf(BakeCommand::class)) {
                    continue;
                }
            }

            /** @var class-string<\Bake\Command\BakeCommand> $class */
            $candidates[$class::defaultName()] = $class;
        }

        return $candidates;
    }
}