Overview

Namespaces

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

Classes

  • Console
  • ConsoleFactory

Interfaces

  • IInputProvider
  • IOutputProvider
  • IParameterParser

Exceptions

  • ApplicationException
  • ConsoleException
  • Exception
  • InputException
  • InvalidArgumentException
  • InvalidValueException
  • MissingException
  • MissingParameterException
  • OutputException
  • ParameterParserException
  • StaticClassException
  • Overview
  • Namespace
  • Class

Class Console

Namespace: CzProject\PhpCli
Located at Console.php
Methods summary
public
# __construct( CzProject\PhpCli\IOutputProvider $outputProvider, CzProject\PhpCli\IInputProvider $inputProvider, CzProject\PhpCli\IParameterParser $parameterParser )
public string
# getCurrentDirectory( )

Returns

string

Throws

CzProject\PhpCli\ConsoleException
public static
# setCurrentDirectory( string $directory )

Parameters

$directory

Returns

static
public static
# addRawParameters( array $rawParameters = NULL )

Returns

static
public static
# processRawParameters( array $rawParameters = NULL )

Returns

static
public static
# addParameters( array $parameters = NULL )

Parameters

$parameters

Returns

static
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 CzProject\PhpCli\IOutputProvider
# getOutputProvider( )

Returns

CzProject\PhpCli\IOutputProvider
public static
# output( string|string[] $str )

Parameters

$str

Returns

static
public static
# success( string|string[] $str )

Parameters

$str

Returns

static
public static
# error( string|string[] $str )

Parameters

$str

Returns

static
public static
# warning( string|string[] $str )

Parameters

$str

Returns

static
public static
# info( string|string[] $str )

Parameters

$str

Returns

static
public static
# muted( string|string[] $str )

Parameters

$str

Returns

static
public static
# nl( )

Returns

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

Parameters

$msg
optional

Returns

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

Parameters

$msg
optional

Returns

string
Properties summary
protected CzProject\PhpCli\IOutputProvider $outputProvider
#
protected CzProject\PhpCli\IInputProvider $inputProvider
#
protected CzProject\PhpCli\IParameterParser $parameterParser
#
protected array|null $parameters
#
czproject/phpcli v3.0.0-beta API documentation API documentation generated by ApiGen