Overview

Namespaces

  • Cz
    • Cli
      • Inputs
      • Outputs
      • Parameters

Classes

  • Console
  • ConsoleFactory

Interfaces

  • IInputProvider
  • IOutputFormatter
  • IParametersParser

Exceptions

  • ConsoleException
  • InputException
  • OutputException
  • ParametersException
  • ParametersParseException
  • Overview
  • Namespace
  • Class

Class Console

Namespace: Cz\Cli
Located at Console.php
Methods summary
public
# __construct( Cz\Cli\IOutputFormatter $outputFormatter, Cz\Cli\IInputProvider $inputProvider, Cz\Cli\IParametersParser $parametersParser )
public string
# getCurrentDirectory( boolean $forceRefresh = FALSE )

Parameters

$forceRefresh

Returns

string

Throws

Cz\Cli\ConsoleException
public Cz\Cli\Console
# setCurrentDirectory( string $directory )

Parameters

$directory

Returns

Cz\Cli\Console
public Cz\Cli\Console
# setRawParameters( array $parameters = NULL )

Returns

Cz\Cli\Console
public Cz\Cli\Console
# setDefaultParameters( array $defaultParameters = NULL )

Parameters

$defaultParameters

Returns

Cz\Cli\Console
public array|null
# getParameters( )

Returns

array|null
public mixed
# getParameter( string $name, mixed $defaultValue = NULL, boolean $required = FALSE )

Parameters

$name
$defaultValue
$required

Returns

mixed
public Cz\Cli\Console
# output( string|null $str = NULL )

Parameters

$str

Returns

Cz\Cli\Console
public Cz\Cli\Console
# success( string|null $str = NULL )

Parameters

$str

Returns

Cz\Cli\Console
public Cz\Cli\Console
# error( string|null $str = NULL )

Parameters

$str

Returns

Cz\Cli\Console
public Cz\Cli\Console
# warning( string|null $str = NULL )

Parameters

$str

Returns

Cz\Cli\Console
public Cz\Cli\Console
# info( string|null $str = NULL )

Parameters

$str

Returns

Cz\Cli\Console
public Cz\Cli\IOutputFormatter
# nl( )

Returns

Cz\Cli\IOutputFormatter
public Cz\Cli\IOutputFormatter
# setAutoNewLine( boolean $state )

Parameters

$state

Returns

Cz\Cli\IOutputFormatter
public boolean
# getAutoNewLine( )

Returns

boolean
public string
# input( string|null $msg = NULL )

Parameters

$msg
optional

Returns

string
public string
# readInput( string|null $msg = NULL )

Parameters

$msg
optional

Returns

string
public Cz\Cli\IOutputFormatter
# enableNewLine( )

Returns

Cz\Cli\IOutputFormatter
public Cz\Cli\IOutputFormatter
# disableNewLine( )

Returns

Cz\Cli\IOutputFormatter
Properties summary
protected Cz\Cli\IOutputFormatter $outputFormatter
#
protected Cz\Cli\IInputProvider $inputProvider
#
protected Cz\Cli\IParametersParser $parametersParser
#
protected string|null $currentDirectory
#
czproject/phpcli v2.0.0-beta2 API documentation API documentation generated by ApiGen