Overview

Namespaces

  • Cz
    • Cli
      • Inputs
      • Outputs
      • Parameters

Classes

  • Cz\Cli\Console
  • Cz\Cli\ConsoleFactory
  • Cz\Cli\Inputs\DefaultInputProvider
  • Cz\Cli\Inputs\ReadlineInputProvider
  • Cz\Cli\Outputs\BaseOutput
  • Cz\Cli\Outputs\ColoredOutput
  • Cz\Cli\Outputs\NullOutput
  • Cz\Cli\Outputs\TextOutput
  • Cz\Cli\Parameters\BaseParser
  • Cz\Cli\Parameters\DefaultParametersParser

Interfaces

  • Cz\Cli\IInputProvider
  • Cz\Cli\IOutputFormatter
  • Cz\Cli\IParametersParser

Exceptions

  • Cz\Cli\ConsoleException
  • Cz\Cli\InputException
  • Cz\Cli\OutputException
  • Cz\Cli\ParametersException
  • Cz\Cli\ParametersParseException
  • 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: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 
<?php
    /** Cz CLI Console
     *
     * @author      Jan Pecha, <janpecha@email.cz>
     */

    namespace Cz\Cli;

    class Console
    {
        /** @var  IOutputFormatter */
        protected $outputFormatter;

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

        /** @var  IParametersParser */
        protected $parametersParser;

        /** @var  string|NULL */
        protected $currentDirectory;



        public function __construct(IOutputFormatter $outputFormatter, IInputProvider $inputProvider, IParametersParser $parametersParser)
        {
            $this->outputFormatter = $outputFormatter;
            $this->inputProvider = $inputProvider;
            $this->parametersParser = $parametersParser;
        }



        /**
         * @param   bool
         * @return  string
         * @throws  ConsoleException
         */
        public function getCurrentDirectory($forceRefresh = FALSE)
        {
            if($forceRefresh || $this->currentDirectory === NULL)
            {
                $cwd = getcwd();

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

                $this->currentDirectory = $cwd;
            }

            return $this->currentDirectory;
        }



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

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

            $this->getCurrentDirectory(TRUE); // force refresh of CWD
            return $this;
        }



        /**
         * @return  self
         */
        public function setRawParameters(array $parameters = NULL)
        {
            $this->parametersParser->setRawParameters($parameters);
            return $this;
        }



        /**
         * @param   array|NULL
         * @return  self
         */
        public function setDefaultParameters(array $defaultParameters = NULL)
        {
            $this->parametersParser->setDefaultParameters($defaultParameters);
            return $this;
        }



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



        /**
         * @param   string
         * @param   mixed
         * @param   bool
         * @return  mixed
         */
        public function getParameter($name, $defaultValue = NULL, $required = FALSE)
        {
            return $this->parametersParser->getParameter($name, $defaultValue, $required);
        }



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

            return $this->outputFormatter;
        }



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



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



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



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



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



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



        /**
         * @param   bool
         * @return  IOutputFormatter
         */
        public function setAutoNewLine($state)
        {
            return $this->outputFormatter->setAutoNewLine($state);
        }



        /**
         * @return  bool
         */
        public function getAutoNewLine()
        {
            return $this->outputFormatter->getAutoNewLine();
        }



        /**
         * @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())
            {
                $currentAutoNewLine = $this->outputFormatter->getAutoNewLine();
                $this->outputFormatter->setAutoNewLine(FALSE) // disable new lines after output()
                    ->output($msg) // print message
                    ->output($msg !== '' ? ' ' : '') // print one space for not empty message
                    ->setAutoNewLine($currentAutoNewLine); // restore settings
            }

            return $this->inputProvider->readInput($msg);
        }



        /**
         * @return  IOutputFormatter
         */
        public function enableNewLine()
        {
            return $this->setAutoNewLine(TRUE);
        }



        /**
         * @return  IOutputFormatter
         */
        public function disableNewLine()
        {
            return $this->setAutoNewLine(FALSE);
        }
    }



    class ConsoleException extends \RuntimeException
    {
    }

czproject/phpcli v2.0.0-beta4 API documentation API documentation generated by ApiGen