Cli.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Cli\Application as CliApplication;
use Elgg\Cli\BaseCommand;
use Elgg\Cli\Command;
use Elgg\Traits\Loggable;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class Cli {

    use Loggable;

    protected $console;

    public function __construct(
        protected EventsService $events,
        protected InputInterface $input,
        protected OutputInterface $output
    ) {
        $console = new \Elgg\Cli\Application('Elgg', elgg_get_release());
        $console->setup($input, $output);

        $this->console = $console;
    }

    protected function bootstrap(): void {
        $commands = array_merge($this->getCoreCommands(), $this->getPluginCommands());
        $commands = $this->events->triggerResults('commands', 'cli', [], $commands);

        foreach ($commands as $command) {
            $this->add($command);
        }
    }

    protected function getCoreCommands(): array {
        $conf = \Elgg\Project\Paths::elgg() . 'engine/cli_commands.php';
        return \Elgg\Includer::includeFile($conf);
    }

    protected function getPluginCommands(): array {
        $return = [];
        
        $plugins = elgg_get_plugins('active');
        foreach ($plugins as $plugin) {
            $plugin_commands = $plugin->getStaticConfig('cli_commands', []);
            if (empty($plugin_commands)) {
                continue;
            }
            
            $return = array_merge($return, $plugin_commands);
        }
        
        return $return;
    }

    public function add(string $command): void {
        if (!class_exists($command)) {
            return;
        }

        if (!is_subclass_of($command, BaseCommand::class)) {
            return;
        }

        $command = new $command();
        
        $command->setLogger($this->getLogger());
        
        if (!is_subclass_of($command, Command::class)) {
            $this->console->add($command);
            return;
        }

        // Execute command as a given user
        $command->addOption('as', 'u', InputOption::VALUE_OPTIONAL,
            elgg_echo('cli:option:as')
        );
        
        // Change language
        $command->addOption('language', null, InputOption::VALUE_OPTIONAL,
            elgg_echo('cli:option:language')
        );

        $this->console->add($command);
    }

    public function run(bool $bootstrap = true): void {
        if ($bootstrap) {
            $this->bootstrap();
        }
        
        $this->console->run($this->input, $this->output);
    }

    public function getInput(): InputInterface {
        return $this->input;
    }

    public function getOutput(): OutputInterface {
        return $this->output;
    }
}