HEX
Server: Apache
System: Linux p3plzcpnl506847.prod.phx3.secureserver.net 4.18.0-553.54.1.lve.el8.x86_64 #1 SMP Wed Jun 4 13:01:13 UTC 2025 x86_64
User: slfopp7cb1df (5698090)
PHP: 8.1.34
Disabled: NONE
Upload Files
File: /home/slfopp7cb1df/public_html/sitepacket.com/system/system/Commands/Utilities/FilterCheck.php
<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Commands\Utilities;

use CodeIgniter\CLI\BaseCommand;
use CodeIgniter\CLI\CLI;
use CodeIgniter\Commands\Utilities\Routes\FilterCollector;

/**
 * Check filters for a route.
 */
class FilterCheck extends BaseCommand
{
    /**
     * The group the command is lumped under
     * when listing commands.
     *
     * @var string
     */
    protected $group = 'CodeIgniter';

    /**
     * The Command's name
     *
     * @var string
     */
    protected $name = 'filter:check';

    /**
     * the Command's short description
     *
     * @var string
     */
    protected $description = 'Check filters for a route.';

    /**
     * the Command's usage
     *
     * @var string
     */
    protected $usage = 'filter:check <HTTP method> <route>';

    /**
     * the Command's Arguments
     *
     * @var array<string, string>
     */
    protected $arguments = [
        'method' => 'The HTTP method. GET, POST, PUT, etc.',
        'route'  => 'The route (URI path) to check filters.',
    ];

    /**
     * the Command's Options
     *
     * @var array<string, string>
     */
    protected $options = [];

    /**
     * @return int exit code
     */
    public function run(array $params)
    {
        if (! $this->checkParams($params)) {
            return EXIT_ERROR;
        }

        $method = $params[0];
        $route  = $params[1];

        // Load Routes
        service('routes')->loadRoutes();

        $filterCollector = new FilterCollector();

        $filters = $filterCollector->get($method, $route);

        // PageNotFoundException
        if ($filters['before'] === ['<unknown>']) {
            CLI::error(
                "Can't find a route: " .
                CLI::color(
                    '"' . strtoupper($method) . ' ' . $route . '"',
                    'black',
                    'light_gray',
                ),
            );

            return EXIT_ERROR;
        }

        $this->showTable($filterCollector, $filters, $method, $route);
        $this->showFilterClasses($filterCollector, $method, $route);

        return EXIT_SUCCESS;
    }

    /**
     * @param array<int|string, string|null> $params
     */
    private function checkParams(array $params): bool
    {
        if (! isset($params[0], $params[1])) {
            CLI::error('You must specify a HTTP verb and a route.');
            CLI::write('  Usage: ' . $this->usage);
            CLI::write('Example: filter:check GET /');
            CLI::write('         filter:check PUT products/1');

            return false;
        }

        return true;
    }

    /**
     * @param array{before: list<string>, after: list<string>} $filters
     */
    private function showTable(
        FilterCollector $filterCollector,
        array $filters,
        string $method,
        string $route,
    ): void {
        $thead = [
            'Method',
            'Route',
            'Before Filters',
            'After Filters',
        ];

        $required = $filterCollector->getRequiredFilters();

        $coloredRequired = $this->colorItems($required);

        $before = array_merge($coloredRequired['before'], $filters['before']);
        $after  = array_merge($filters['after'], $coloredRequired['after']);

        $tbody   = [];
        $tbody[] = [
            strtoupper($method),
            $route,
            implode(' ', $before),
            implode(' ', $after),
        ];

        CLI::table($tbody, $thead);
    }

    /**
     * Color all elements of the array.
     *
     * @param array<array-key, mixed> $array
     *
     * @return array<array-key, mixed>
     */
    private function colorItems(array $array): array
    {
        return array_map(function ($item): array|string {
            if (is_array($item)) {
                return $this->colorItems($item);
            }

            return CLI::color($item, 'yellow');
        }, $array);
    }

    private function showFilterClasses(
        FilterCollector $filterCollector,
        string $method,
        string $route,
    ): void {
        $requiredFilterClasses = $filterCollector->getRequiredFilterClasses();
        $filterClasses         = $filterCollector->getClasses($method, $route);

        $coloredRequiredFilterClasses = $this->colorItems($requiredFilterClasses);

        $classList = [
            'before' => array_merge($coloredRequiredFilterClasses['before'], $filterClasses['before']),
            'after'  => array_merge($filterClasses['after'], $coloredRequiredFilterClasses['after']),
        ];

        foreach ($classList as $position => $classes) {
            CLI::write(ucfirst($position) . ' Filter Classes:', 'cyan');
            CLI::write(implode(' → ', $classes));
        }
    }
}