AbstractCliApplication.php

<?php declare(strict_types=1);
/**
 * Part of Windwalker project.
 *
 * @copyright  Copyright (C) 2019 LYRASOFT.
 * @license    LGPL-2.0-or-later
 */

namespace Windwalker\Application;

use Windwalker\IO\Cli\IO;
use Windwalker\IO\Cli\IOInterface;
use Windwalker\Structure\Structure;

/**
 * Simple class for a Windwalker command line application.
 *
 * @property-read  IOInterface $io
 *
 * @since  2.0
 */
abstract class AbstractCliApplication extends AbstractApplication
{
    /**
     * The CLI In/Out object.
     *
     * @var    IOInterface
     * @since  2.0
     */
    protected $io = null;

    /**
     * Class constructor.
     *
     * @param   IOInterface $io       An optional argument to provide dependency injection for the application's
     *                                IO object.
     * @param   Structure   $config   An optional argument to provide dependency injection for the application's
     *                                config object.  If the argument is a Structure object that object will become
     *                                the application's config object, otherwise a default config object is created.
     *
     * @since   2.0
     */
    public function __construct(IOInterface $io = null, Structure $config = null)
    {
        // Close the application if we are not executed from the command line.
        if (!defined('STDOUT') || !defined('STDIN') || !isset($_SERVER['argv'])) {
            $this->close();
        }

        $this->io = $io instanceof IOInterface ? $io : new IO();
        $this->config = $config instanceof Structure ? $config : new Structure();

        $this->init();

        // Set the execution datetime and timestamp;
        $this->set('execution.datetime', gmdate('Y-m-d H:i:s'));
        $this->set('execution.timestamp', time());

        // Set the current directory.
        $this->set('cwd', getcwd());
    }

    /**
     * Write a string to standard output.
     *
     * @param   string  $text The text to display.
     * @param   boolean $nl   True (default) to append a new line at the end of the output string.
     *
     * @return  AbstractCliApplication  Instance of $this to allow chaining.
     *
     * @since   2.0
     */
    public function out($text = '', $nl = true)
    {
        $this->io->out($text, $nl);

        return $this;
    }

    /**
     * Get a value from standard input.
     *
     * @return  string  The input string from standard input.
     *
     * @since   2.0
     */
    public function in()
    {
        return $this->io->in();
    }

    /**
     * Get the IO object.
     *
     * @return  IOInterface
     */
    public function getIO()
    {
        return $this->io;
    }

    /**
     * Set the IO object.
     *
     * @param   IOInterface $io The IO object.
     *
     * @return  AbstractCliApplication  Return self to support chaining.
     */
    public function setIO($io)
    {
        $this->io = $io;

        return $this;
    }

    /**
     * is utilized for reading data from inaccessible members.
     *
     * @param   $name  string
     *
     * @return  mixed
     */
    public function __get($name)
    {
        $allowNames = ['io'];

        if (in_array($name, $allowNames)) {
            return $this->$name;
        }

        return parent::__get($name);
    }
}