allebb/clip

<?php

namespace Ballen\Clip;

use Ballen\Clip\Utilities\ArgumentsParser;
use Ballen\Clip\Utilities\CommandRouter;
use InvalidArgumentException;

/**
 * Clip
 * 
 * A package for speeding up development of PHP console (CLI) applications.
 *
 * @author Bobby Allen <ballen@bobbyallen.me>
 * @license https://raw.githubusercontent.com/bobsta63/clip/master/LICENSE
 * @link https://github.com/allebb/clip
 * @link http://www.bobbyallen.me
 *
 */
class ConsoleApplication
{

    /**
     * The CLI arguments
     * @var ArgumentsParser
     */
    private $arguments;

    /**
     * Command routing configuration.
     * @var CommandRouter 
     */
    private $router;

    /**
     * Console Application Constructor
     * @param ArgumentsParser $argv The PHP $argv array (Pass $argv global if you wish to access the CLI arguments)
     */
    public function __construct(ArgumentsParser $argv)
    {
        $this->arguments = $argv;
        $this->router = new CommandRouter();
    }

    /**
     * Returns the CLI arguments exposed to the CLI application.
     * @return ArgumentsParser
     */
    public function arguments()
    {
        return $this->arguments;
    }

    /**
     * Returns the router instance.
     * @return CommandRouter
     */
    public function router()
    {
        return $this->router;
    }

    /**
     * Enforces that the script must be run at the console.
     * @param boolean $enforced Enforce execution only through the CLI.
     * @param string $error_message Custom error message.
     * @return void
     */
    public function enforceCli($enforced = false, $error_message = 'CLI execution permitted only!')
    {
        if ($enforced && (php_sapi_name() != "cli")) {
            die($error_message);
        }
    }

    /**
     * Checks that the user is root!
     * @return boolean
     */
    public function isSuperUser()
    {
        if (!function_exists('posix_getuid')) {
            throw new RuntimeException('The isSuperUser() method requires the PHP POSIX extention to be enabled!');
        }
        if (posix_getuid() == 0) {
            return true;
        }
        return false;
    }

    /**
     * Executes a system command.
     * @param string $command The command to execute.
     * @return string
     */
    public function call($command)
    {
        return system($command);
    }

    /**
     * Write to the console.
     * @param string $text The text to output.
     * @return \Ballen\Clip\ConsoleApplication
     */
    public function write($text = '')
    {
        fwrite(STDOUT, $text);
        return $this;
    }

    /**
     * Write a line of characters (or an empty line) to the CLI.
     * @param string $text The text to output.
     * @return \Ballen\Clip\ConsoleApplication
     */
    public function writeln($text = '')
    {
        $this->write($text . PHP_EOL);
        return $this;
    }

    /**
     * Request user input
     * @param string $question The input question/text
     * @param string $default A default value if one is not selected.
     * @param array $options Valid options that are acceptable, these are case insensitive!
     * @return string
     */
    public function input($question, $default = '', $options = [])
    {
        if (empty($default)) {
            $this->write($question . ' ');
        } elseif (empty($options)) {
            $this->write($question . ' [' . $default . '] ');
        } else {
            $available_options = [];
            foreach (strtolower($options) as $option) {
                if ($option === strtolower($default)) {
                    $option = strtoupper($option);
                }
                $available_options[] = $option;
            }
            $available_opts = rtrim(implode($available_options, '/'), '/');
            $this->write($question . ' [' . $available_opts . '] ');
        }
        $answer = rtrim(fgets(STDIN), PHP_EOL);
        if (empty($answer)) {
            return $default;
        }
        if (count($options) > 0) {
            if (!in_array(strtolower($answer), array_map('strtolower', $options))) {
                return $this->input($question, $default, $options);
            }
            return $answer;
        }
        return $answer;
    }

    /**
     * Writes an array to the CLI output
     * @param array $array The array of data to write to the console.
     * @return \Ballen\Clip\ConsoleApplication
     */
    public function writearr($array = [])
    {
        print_r($array);
        return $this;
    }

    /**
     * Exits with a specific status code.
     * @param int $status The status code to exit with.
     * @throws InvalidArgumentException
     */
    public function exitWithStatus($status = 0)
    {
        if (!is_int($status)) {
            throw new InvalidArgumentException('The status code must be an integer value.');
        }
        exit($status);
    }

    /**
     * Exits the CLI with status code 0 (Successful)
     * @return void
     */
    public function exitWithSuccess()
    {
        $this->exitWithStatus(0);
    }

    /**
     * Exits the CLI with statu code 1 (Error)
     * @return void
     */
    public function exitWithError()
    {
        $this->exitWithStatus(1);
    }

    /**
     * Run the current application.
     * @return void
     */
    public function run()
    {
        $this->router()->dispatch($this->arguments()->getCommand(1));
    }
}