Overview

Namespaces

  • CzProject
    • PhpCli
      • Application
      • Bridges
      • Inputs
      • Outputs
      • Parameters

Classes

  • CzProject\PhpCli\Application\Application
  • CzProject\PhpCli\Application\ApplicationRequest
  • CzProject\PhpCli\Bridges\NetteDIExtension
  • CzProject\PhpCli\Console
  • CzProject\PhpCli\ConsoleFactory
  • CzProject\PhpCli\Inputs\DefaultInputProvider
  • CzProject\PhpCli\Inputs\ReadlineInputProvider
  • CzProject\PhpCli\Outputs\BaseOutput
  • CzProject\PhpCli\Outputs\ColoredOutput
  • CzProject\PhpCli\Outputs\MemoryOutput
  • CzProject\PhpCli\Outputs\NullOutput
  • CzProject\PhpCli\Outputs\TextOutput
  • CzProject\PhpCli\Parameters\DefaultParameterParser
  • CzProject\PhpCli\Parameters\Helpers

Interfaces

  • CzProject\PhpCli\Application\ICommand
  • CzProject\PhpCli\IInputProvider
  • CzProject\PhpCli\IOutputProvider
  • CzProject\PhpCli\IParameterParser

Exceptions

  • CzProject\PhpCli\ApplicationException
  • CzProject\PhpCli\ConsoleException
  • CzProject\PhpCli\Exception
  • CzProject\PhpCli\InputException
  • CzProject\PhpCli\InvalidArgumentException
  • CzProject\PhpCli\InvalidValueException
  • CzProject\PhpCli\MissingException
  • CzProject\PhpCli\MissingParameterException
  • CzProject\PhpCli\OutputException
  • CzProject\PhpCli\ParameterParserException
  • CzProject\PhpCli\StaticClassException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 
<?php

    namespace CzProject\PhpCli;


    class Console
    {
        /** @var  IOutputProvider */
        protected $outputProvider;

        /** @var  IInputProvider */
        protected $inputProvider;

        /** @var  IParameterParser */
        protected $parameterParser;

        /** @var  array|NULL */
        protected $parameters;


        public function __construct(IOutputProvider $outputProvider, IInputProvider $inputProvider, IParameterParser $parameterParser)
        {
            $this->outputProvider = $outputProvider;
            $this->inputProvider = $inputProvider;
            $this->parameterParser = $parameterParser;
        }


        /**
         * @return string
         * @throws ConsoleException
         */
        public function getCurrentDirectory()
        {
            $cwd = getcwd();

            if ($cwd === FALSE) {
                throw new ConsoleException('CWD error');
            }

            return $cwd;
        }


        /**
         * @param  string
         * @return static
         */
        public function setCurrentDirectory($directory)
        {
            if ($directory[0] !== '/') {
                $directory = $this->getCurrentDirectory() . "/$directory";
            }

            if (!chdir($directory)) {
                throw new ConsoleException('CWD set error');
            }

            return $this;
        }


        /**
         * @return static
         */
        public function addRawParameters(array $rawParameters = NULL)
        {
            $parameters = $this->processRawParameters($rawParameters);
            $this->addParameters($parameters);
            return $this;
        }


        /**
         * @return static
         */
        public function processRawParameters(array $rawParameters = NULL)
        {
            return $this->parameterParser->parse($rawParameters);
        }


        /**
         * @param  array|NULL
         * @return static
         */
        public function addParameters(array $parameters = NULL)
        {
            $this->parameters = Parameters\Helpers::merge($parameters, $this->parameters);
            return $this;
        }


        /**
         * @return array|NULL
         */
        public function getParameters()
        {
            return $this->parameters;
        }


        /**
         * @param  string
         * @param  mixed
         * @param  bool
         * @return mixed
         */
        public function getParameter($name, $defaultValue = NULL, $required = FALSE)
        {
            if (!isset($this->parameters[$name])) {
                if ($required) {
                    throw new MissingParameterException("Required parameter '$name' not found.");
                }

                return $defaultValue;
            }

            return $this->parameters[$name];
        }


        /**
         * @return IOutputProvider
         */
        public function getOutputProvider()
        {
            return $this->outputProvider;
        }


        /**
         * @param  string|string[]
         * @return static
         */
        public function output($str)
        {
            if (!is_array($str)) {
                $str = func_get_args();
            }
            $this->outputProvider->output($str);
            return $this;
        }


        /**
         * @param  string|string[]
         * @return static
         */
        public function success($str)
        {
            if (!is_array($str)) {
                $str = func_get_args();
            }
            $this->outputProvider->success($str);
            return $this;
        }


        /**
         * @param  string|string[]
         * @return static
         */
        public function error($str)
        {
            if (!is_array($str)) {
                $str = func_get_args();
            }
            $this->outputProvider->error($str);
            return $this;
        }


        /**
         * @param  string|string[]
         * @return static
         */
        public function warning($str)
        {
            if (!is_array($str)) {
                $str = func_get_args();
            }
            $this->outputProvider->warning($str);
            return $this;
        }


        /**
         * @param  string|string[]
         * @return static
         */
        public function info($str)
        {
            if (!is_array($str)) {
                $str = func_get_args();
            }
            $this->outputProvider->info($str);
            return $this;
        }


        /**
         * @param  string|string[]
         * @return static
         */
        public function muted($str)
        {
            if (!is_array($str)) {
                $str = func_get_args();
            }
            $this->outputProvider->muted($str);
            return $this;
        }


        /**
         * @return static
         */
        public function nl()
        {
            $this->outputProvider->nl();
            return $this;
        }


        /**
         * @param  string|NULL  optional
         * @return string
         */
        public function input($msg = NULL)
        {
            return $this->readInput($msg);
        }


        /**
         * @param  string|NULL  optional
         * @return string
         */
        public function readInput($msg = NULL)
        {
            $msg = $msg !== NULL ? (string) $msg : $msg;

            if (!$this->inputProvider->isPrintingPrompt()) {
                $this->outputProvider->output($msg) // print message
                    ->output($msg !== '' ? ' ' : ''); // print one space for not empty message
            }

            return $this->inputProvider->readInput($msg);
        }
    }
czproject/phpcli master API documentation API documentation generated by ApiGen