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\IOutputProvider
  • 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: 
<?php
    /**
     * Cz CLI Console
     * @author Jan Pecha, <janpecha@email.cz>
     */

    namespace Cz\Cli;
    use Cz\Cli\Inputs,
        Cz\Cli\Outputs,
        Cz\Cli\Parameters;

    class ConsoleFactory
    {
        /** @var  bool|NULL */
        protected static $useColoredOutput;

        /** @var  bool|NULL */
        protected static $useReadlineProvider;



        /**
         * @return  Console
         */
        public static function createConsole(IOutputProvider $outputProvider = NULL, IInputProvider $inputProvider = NULL, IParametersParser $parser = NULL)
        {
            $outputProvider = $outputProvider === NULL ? self::createOutputProvider() : $outputProvider;
            $inputProvider = $inputProvider === NULL ? self::createInputProvider() : $inputProvider;
            $parser = $parser === NULL ? self::createParamatersParser() : $parser;

            return new Console($outputProvider, $inputProvider, $parser);
        }



        /**
         * @return  IOutputProvider
         */
        public static function createOutputProvider()
        {
            if(self::$useColoredOutput === NULL)
            {
                self::$useColoredOutput = self::detectColoredOutput();
            }

            if(self::$useColoredOutput)
            {
                return new Outputs\ColoredOutput;
            }

            return new Outputs\TextOutput;
        }



        /**
         * @return  IOutputProvider
         */
        public static function createNullOutputProvider()
        {
            return new Outputs\NullOutput;
        }



        /**
         * @return  IInputProvider
         */
        public static function createInputProvider()
        {
            if(self::$useReadlineProvider === NULL)
            {
                self::$useReadlineProvider = self::detectReadline();
            }

            if(self::$useReadlineProvider)
            {
                return new Inputs\ReadlineInputProvider;
            }

            return new Inputs\DefaultInputProvider;
        }



        /**
         * @return  IParametersParser
         */
        public static function createParamatersParser()
        {
            return new Parameters\DefaultParametersParser;
        }



        /**
         * @return  bool
         */
        public static function detectColoredOutput()
        {
            // Code from Tracy (from Nette Framework)
            // see https://github.com/nette/tracy/blob/master/src/Tracy/Dumper.php#L315-L317
            return (getenv('ConEmuANSI') === 'ON'
                || getenv('ANSICON') !== FALSE
                || (defined('STDOUT') && function_exists('posix_isatty') && posix_isatty(STDOUT)));
        }



        /**
         * @return  bool
         */
        public static function detectReadline()
        {
            if(extension_loaded('readline'))
            {
                return TRUE;
            }

            return function_exists('readline') && function_exists('readline_add_history');
        }
    }

czproject/phpcli version-2 API documentation API documentation generated by ApiGen