examples/ControllerHomeController.php

<?php declare(strict_types=1);

namespace Inhere\Console\Examples\Controller;

use Inhere\Console\Component\Symbol\ArtFont;
use Inhere\Console\Controller;
use Inhere\Console\IO\Input;
use Inhere\Console\Util\Interact;
use Inhere\Console\Util\ProgressBar;
use Inhere\Console\Util\Show;
use LogicException;
use RuntimeException;
use Toolkit\Cli\Cli;
use Toolkit\Cli\Download;
use Toolkit\Stdlib\Php;
use function sleep;
use function trigger_error;

/**
 * default command controller. there are some command usage examples(1)
 * Class HomeController
 * @package Inhere\Console\Examples\Controller
 */
class HomeController extends Controller
{
    protected static $name = 'home';

    protected static $description = 'This is a demo command controller. there are some command usage examples(2)';

    /**
     * @return array
     */
    protected static function commandAliases(): array
    {
        return [
            // now, 'home:i' is equals to 'home:index'
            'i'   => 'index',
            'prg' => 'progress',
            'pgb' => 'progressBar',
            'l'   => 'list',
            'af'  => 'artFont',
            'ml'  => 'multiList',
            'sl'  => 'splitLine',
            'dt'  => 'dynamicText',
            'da'  => 'defArg',
        ];
    }

    protected function init(): void
    {
        parent::init();

        $this->addCommentsVar('internalFonts', implode(',', ArtFont::getInternalFonts()));

        $this->setCommandMeta('defArg', [
            'desc' => 'the command args and opts config use defined configure, it like symfony console, please see defArgConfigure()',
        ]);
    }

    /**
     * @return array
     */
    protected function groupOptions(): array
    {
        return [
            '-c, --common' => 'This is a common option for all sub-commands',
        ];
    }

    protected function disabledCommands(): array
    {
        return ['disabled'];
    }

    protected function afterExecute(): void
    {
        // $this->write('after command execute');
    }

    /**
     * this is a command's description message
     * the second line text
     *
     * @usage {command} [arg ...] [--opt ...]
     * @arguments
     *  arg1        argument description 1
     *              the second line
     *  a2,arg2     argument description 2
     *              the second line
     * @options
     *  -s, --long  option description 1
     *  --opt       option description 2
     * @example example text one
     *  the second line example
     */
    public function testCommand(): void
    {
        $this->write('hello, welcome!! this is ' . __METHOD__);
    }

    /**
     * this is a disabled command. please see 'disabledCommands()'
     */
    public function disabledCommand(): void
    {
        $this->write('hello, welcome!! this is ' . __METHOD__);
    }

    /**
     * command `defArgCommand` config
     * @throws LogicException
     */
    protected function defArgConfigure(): void
    {
        $this->createDefinition()
            // ->setDescription('the command args and opts config use defined configure, it like symfony console, please see defArgConfigure()')
            ->addArgument('name', Input::ARG_REQUIRED, "description for the argument 'name'")
            ->addOption('yes', 'y', Input::OPT_BOOLEAN, "description for the option 'yes'")
            ->addOption('opt1', null, Input::OPT_REQUIRED, "description for the option 'opt1'");
    }

    // desc set at $this->commandMetas.
    public function defArgCommand(): void
    {
        $this->output->dump($this->input->getArgs(), $this->input->getOpts(), $this->input->getBoolOpt('y'));
    }

    /**
     * a command for test throw exception
     * @throws RuntimeException
     */
    public function exCommand(): void
    {
        throw new RuntimeException('oo, this is a runtime exception!');
    }

    /**
     * a command for test trigger error
     */
    public function errorCommand(): void
    {
        trigger_error('oo, this is a runtime error!', E_USER_ERROR);
    }

    /**
     * will run other command in the command.
     */
    public function subRunCommand(): void
    {
        $this->writeln('hello this is: ' . __METHOD__);

        $this->getApp()->subRun('test', $this->input, $this->output);
    }

    /**
     * dump current env information
     */
    public function dumpEnvCommand(): void
    {
        $this->output->aList($_SERVER, '$_SERVER data');
    }

    /**
     * check color support for current env.
     */
    public function colorCheckCommand(): void
    {
        // $char= '❤';
        // $ret = ProcessUtil::run('echo ❤');
        // var_dump($ret, trim($ret[1]), $char === trim($ret[1]));
        //
        // die;

        $this->output->aList([
            'basic color output?' => Cli::isSupportColor() ? '<info>Y</info>' : 'N',
            'ansi char output?'   => Cli::isAnsiSupport() ? 'Y' : 'N',
            '256 color output?'   => Cli::isSupport256Color() ? 'Y' : 'N',
            'font symbol output?' => Cli::isSupport256Color() ? 'Y' : 'N',
        ], 'color support check');
    }

    /**
     * output art font text
     * @options
     *  --font    Set the art font name(allow: {internalFonts}).
     *  --italic  Set the art font type is italic.
     *  --style   Set the art font style.
     * @return int
     */
    public function artFontCommand(): int
    {
        $name = $this->input->getLongOpt('font', '404');

        if (!ArtFont::isInternalFont($name)) {
            return $this->output->liteError("Your input font name: $name, is not exists. Please use '-h' see allowed.");
        }

        ArtFont::create()->show($name, ArtFont::INTERNAL_GROUP, [
            'type'  => $this->input->getBoolOpt('italic') ? 'italic' : '',
            'style' => $this->input->getOpt('style'),
        ]);

        return 0;
    }

    /**
     * dynamic notice message show: counterTxt. It is like progress txt, but no max value.
     * @example
     *  {script} {command}
     * @return int
     */
    public function counterCommand(): int
    {
        $total = 120;
        $ctt   = Show::counterTxt('handling ...', 'handled.');
        $this->write('Counter:');

        while ($total - 1) {
            $ctt->send(1);
            usleep(30000);
            $total--;
        }

        // end of the counter.
        $ctt->send(-1);

        // $this->output->aList($data, 'runtime profile');

        return 0;
    }

    /**
     * dynamic spinner message, by Show::spinner()
     */
    public function spinnerCommand(): void
    {
        $total = 5000;

        while ($total--) {
            Show::spinner('Data handling ');
            usleep(100);
        }

        Show::spinner('Done', true);
    }

    /**
     * dynamic notice message show: pending
     */
    public function pendingCommand(): void
    {
        $total = 800;

        while ($total--) {
            Show::pending();
            usleep(20000);
        }

        Show::pending('Done', true);
    }

    /**
     * dynamic notice message show: pointing
     */
    public function pointingCommand(): void
    {
        $total = 100;

        while ($total--) {
            Show::pointing();
            usleep(10000);
        }

        Show::pointing('Done', true);
    }

    /**
     * dynamic text message example, by Show::dynamicText
     */
    public function dynamicTextCommand(): void
    {
        $dt = Show::dynamicText('Complete', 'Download file: xyz.zip ... ');
        $dt->send('Start');

        foreach (['Request', 'Downloading', 'Save'] as $txt) {
            sleep(2);
            $dt->send($txt);
        }

        sleep(2);
        $dt->send(false);
    }

    /**
     * a progress bar example show, by Show::progressBar()
     * @options
     *  --type      the progress type, allow: bar,txt. <cyan>txt</cyan>
     *  --done-char the done show char. <info>=</info>
     *  --wait-char the waiting show char. <info>-</info>
     *  --sign-char the sign char show. <info>></info>
     * @example
     *  {script} {command}
     *  {script} {command} --done-char '#' --wait-char ' '
     * @param Input $input
     * @return int
     */
    public function progressCommand($input): int
    {
        $i     = 0;
        $total = 120;
        if ($input->getOpt('type') === 'bar') {
            $bar = $this->output->progressBar($total, [
                'msg'      => 'Msg Text',
                'doneMsg'  => 'Done Msg Text',
                'doneChar' => $input->getOpt('done-char', '='), // ▓
                'waitChar' => $input->getOpt('wait-char', '-'), // ░
                'signChar' => $input->getOpt('sign-char', '>'),
            ]);
        } else {
            $bar = $this->output->progressTxt($total, 'Doing go g...', 'Done');
        }

        $this->write('Progress:');

        while ($i <= $total) {
            $bar->send(1);
            usleep(50000);
            $i++;
        }

        return 0;
    }

    /**
     * a progress bar example show, by class ProgressBar
     * @throws LogicException
     */
    public function progressBarCommand(): void
    {
        $i     = 0;
        $total = 120;
        $bar   = new ProgressBar();
        $bar->start(120);

        while ($i <= $total) {
            $bar->advance();
            usleep(50000);
            $i++;
        }

        $bar->finish();
    }

    /**
     * output format message: list
     */
    public function listCommand(): void
    {
        $list = [
            'The is a list line 0',
            'The is a list line 1',
            'The is a list line 2',
            'The is a list line 3',
        ];

        Show::aList($list, 'a List show(No key)');

        $commands = [
            'version' => 'Show application version information',
            'help'    => 'Show application help information',
            'list'    => 'List all group and independent commands',
            'a only value message text'
        ];

        Show::aList($commands, 'a List show(Has key)');
    }

    /**
     * output format message: multiList
     */
    public function multiListCommand(): void
    {
        Show::multiList([
            'list0' => [
                'value in the list 0',
                'key'  => 'value in the list 0',
                'key1' => 'value1 in the list 0',
                'key2' => 'value2 in the list 0',
            ],
            'list1' => [
                'key'  => 'value in the list 1',
                'key1' => 'value1 in the list 1',
                'key2' => 'value2 in the list 1',
                'value in the list 1',
            ],
            'list2' => [
                'key'  => 'value in the list 2',
                'value in the list 2',
                'key1' => 'value1 in the list 2',
                'key2' => 'value2 in the list 2',
            ],
        ]);
    }

    /**
     * output format message: table
     */
    public function tableCommand(): void
    {
        $data = [
            [
                'id'     => 1,
                'name'   => 'john',
                'status' => 2,
                'email'  => 'john@email.com',
            ],
            [
                'id'     => 2,
                'name'   => 'tom',
                'status' => 0,
                'email'  => 'tom@email.com',
            ],
            [
                'id'     => 3,
                'name'   => 'jack',
                'status' => 1,
                'email'  => 'jack-test@email.com',
            ],
        ];
        Show::table($data, 'table show');

        Show::table($data, 'No border table show', [
            'showBorder' => 0
        ]);

        Show::table($data, 'change style table show', [
            'bodyStyle' => 'info'
        ]);

        $data1 = [
            [
                'Walter White',
                'Father',
                'Teacher',
            ],
            [
                'Skyler White',
                'Mother',
                'Accountant',
            ],
            [
                'Walter White Jr.',
                'Son',
                'Student',
            ],
        ];

        Show::table($data1, 'no head table show');
    }

    /**
     * output format message: padding
     */
    public function paddingCommand(): void
    {
        $data = [
            'Eggs'    => '$1.99',
            'Oatmeal' => '$4.99',
            'Bacon'   => '$2.99',
        ];

        Show::padding($data, 'padding data show');
    }

    /**
     * a example for use arguments on command
     * @usage home:useArg [arg1=val1 arg2=arg2] [options]
     * @example
     *  home:useArg status=2 name=john arg0 -s=test --page=23 -d -rf --debug --test=false -a v1 --ab -c -g --cd val -h '' -i stat=online
     *  home:useArg status=2 name=john name=tom name=jack arg0 -s=test --page=23 --id=23 --id=154 --id=456  -d -rf --debug --test=false
     */
    public function useArgCommand(): void
    {
        $this->write('input arguments:');
        $this->output->dump($this->input->getArgs());

        $this->write('input options:');
        $this->output->dump($this->input->getOpts());

        $this->write('raw argv:');
        $this->output->dump($this->input->getTokens());

        $this->write('raw argv(string):');
        $this->output->dump($this->input->getFullScript());
    }

    /**
     * output current env info
     */
    public function envCommand(): void
    {
        $info = [
            'phpVersion' => PHP_VERSION,
            'env'        => 'test',
            'debug'      => true,
        ];

        Show::panel($info);

        echo Php::printVars($_SERVER);
    }

    /**
     * This is a demo for download a file to local
     * @usage {command} url=url saveTo=[saveAs] type=[bar|text]
     * @example {command} url=https://github.com/inhere/php-console/archive/master.zip type=bar
     */
    public function downCommand(): int
    {
        $url = $this->input->getArg('url');

        if (!$url) {
            $this->output->liteError('Please input you want to downloaded file url, use: url=[url]', 1);
        }

        $saveAs = $this->input->getArg('saveAs');
        $type   = $this->input->getArg('type', 'text');

        if (!$saveAs) {
            $saveAs = __DIR__ . '/' . basename($url);
        }

        $goon = Interact::confirm("Now, will download $url \nto dir $saveAs, go on");

        if (!$goon) {
            Show::notice('Quit download, Bye!');
            return 0;
        }

        Download::file($url, $saveAs, $type);
        // $d = Download::down($url, $saveAs, $type);
        // echo Helper::dumpVars($d);

        return 0;
    }
}