BaseCommand.php

Go to the documentation of this file.

<?php

namespace Elgg\Cli;

use Elgg\Exceptions\RuntimeException;
use Elgg\Traits\Loggable;
use Psr\Log\LogLevel;
use Symfony\Component\Console\Helper\FormatterHelper;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\VarDumper\VarDumper;

abstract class BaseCommand extends \Symfony\Component\Console\Command\Command {

    use Loggable;

    const DEFAULT_VERBOSITY = OutputInterface::VERBOSITY_NORMAL;

    protected $input;

    protected $output;

    public function ask($question, $default = null, $hidden = false, $required = true) {

        /* @var $helper QuestionHelper */
        $helper = $this->getHelper('question');

        $question = trim($question);
        $question = rtrim($question, ':');
        if (is_scalar($default) && !is_bool($default)) {
            $question .= " [{$default}]";
        }
        $question .= ': ';
        
        $q = new Question($question, $default);

        if ($hidden) {
            $q->setHidden(true);
            $q->setHiddenFallback(false);
        }

        if ($required) {
            $q->setValidator([
                $this,
                'assertNotEmpty'
            ]);
            $q->setMaxAttempts(2);
        }

        return $helper->ask($this->input, $this->output, $q);
    }

    final public function dump($data) {
        VarDumper::dump($data);
    }

    final public function write($messages, $level = LogLevel::INFO) {
        $formatter = new FormatterHelper();

        switch ($level) {
            case LogLevel::EMERGENCY :
            case LogLevel::CRITICAL :
            case LogLevel::ALERT :
            case LogLevel::ERROR :
                $style = 'error';
                break;

            case LogLevel::WARNING :
                $style = 'comment';
                break;

            default :
                $style = 'info';
                break;
        }

        $message = $formatter->formatBlock($messages, $style);
        $this->output->writeln($message);
    }

    public function error($message) {
        $this->write($message, LogLevel::ERROR);
    }

    public function notice($message) {
        $this->write($message, LogLevel::NOTICE);
    }

    public function option($name) {
        return $this->input->getOption($name);
    }

    public function argument($name) {
        return $this->input->getArgument($name);
    }

    public function assertNotEmpty($answer) {
        if (empty($answer)) {
            throw new RuntimeException('Please enter a required answer');
        }

        return $answer;
    }

    final protected function dumpRegisters() {
        $registers = _elgg_services()->system_messages->loadRegisters();

        foreach ($registers as $prop => $values) {
            if (!empty($values)) {
                foreach ($values as $msg) {
                    $prop == 'error' ? $this->error($msg) : $this->notice($msg);
                }
            }
        }
    }
}