Composer API
Class

Composer\IO\ConsoleIO

class ConsoleIO extends BaseIO

The Input/Output helper.

Methods

array getAuthentications()

Get all authentication information entered.

from BaseIO
bool hasAuthentication(string $repositoryName)

Verify if the repository has a authentication information.

from BaseIO
array getAuthentication(string $repositoryName)

Get the username and password of repository.

from BaseIO
setAuthentication(string $repositoryName, string $username, string $password = null)

Set the authentication information for the repository.

from BaseIO
loadConfiguration(Config $config)

Loads authentications from a config instance

from BaseIO
null emergency(string $message, array $context = array())

System is unusable.

from BaseIO
null alert(string $message, array $context = array())

Action must be taken immediately.

from BaseIO
null critical(string $message, array $context = array())

Critical conditions.

from BaseIO
null error(string $message, array $context = array())

Runtime errors that do not require immediate action but should typically be logged and monitored.

from BaseIO
null warning(string $message, array $context = array())

Exceptional occurrences that are not errors.

from BaseIO
null notice(string $message, array $context = array())

Normal but significant events.

from BaseIO
null info(string $message, array $context = array())

Interesting events.

from BaseIO
null debug(string $message, array $context = array())

Detailed debug information.

from BaseIO
null log(mixed $level, string $message, array $context = array())

Logs with an arbitrary level.

from BaseIO
__construct(InputInterface $input, OutputInterface $output, HelperSet $helperSet)

Constructor.

enableDebugging(float $startTime)

bool isInteractive()

Is this input means interactive?

bool isDecorated()

Is this output decorated?

bool isVerbose()

Is this output verbose?

bool isVeryVerbose()

Is the output very verbose?

bool isDebug()

Is the output in debug verbosity?

write(string|array $messages, bool $newline = true, int $verbosity = self::NORMAL)

Writes a message to the output.

writeError(string|array $messages, bool $newline = true, int $verbosity = self::NORMAL)

Writes a message to the error output.

overwrite(string|array $messages, bool $newline = true, int $size = null, int $verbosity = self::NORMAL)

Overwrites a previous message to the output.

overwriteError(string|array $messages, bool $newline = true, int $size = null, int $verbosity = self::NORMAL)

Overwrites a previous message to the error output.

string ask(string|array $question, string $default = null)

Asks a question to the user.

bool askConfirmation(string|array $question, bool $default = true)

Asks a confirmation to the user.

mixed askAndValidate(string|array $question, callable $validator, null|int $attempts = null, mixed $default = null)

Asks for a value and validates the response.

string askAndHideAnswer(string $question)

Asks a question to the user and hide the answer.

int|string|array select(string|array $question, array $choices, bool|string $default, bool|int $attempts = false, string $errorMessage = 'Value "%s" is invalid', bool $multiselect = false)

Asks the user to select a value.

Details

in BaseIO at line 27
public array getAuthentications()

Get all authentication information entered.

Return Value

array The map of authentication data

in BaseIO at line 35
public bool hasAuthentication(string $repositoryName)

Verify if the repository has a authentication information.

Parameters

string $repositoryName The unique name of repository

Return Value

bool

in BaseIO at line 43
public array getAuthentication(string $repositoryName)

Get the username and password of repository.

Parameters

string $repositoryName The unique name of repository

Return Value

array The 'username' and 'password'

in BaseIO at line 55
public setAuthentication(string $repositoryName, string $username, string $password = null)

Set the authentication information for the repository.

Parameters

string $repositoryName The unique name of repository
string $username The username
string $password The password

in BaseIO at line 88
public loadConfiguration(Config $config)

Loads authentications from a config instance

Parameters

Config $config

in BaseIO at line 133
public null emergency(string $message, array $context = array())

System is unusable.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 148
public null alert(string $message, array $context = array())

Action must be taken immediately.

Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 162
public null critical(string $message, array $context = array())

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 175
public null error(string $message, array $context = array())

Runtime errors that do not require immediate action but should typically be logged and monitored.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 190
public null warning(string $message, array $context = array())

Exceptional occurrences that are not errors.

Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 202
public null notice(string $message, array $context = array())

Normal but significant events.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 216
public null info(string $message, array $context = array())

Interesting events.

Example: User logs in, SQL logs.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 228
public null debug(string $message, array $context = array())

Detailed debug information.

Parameters

string $message
array $context

Return Value

null

in BaseIO at line 241
public null log(mixed $level, string $message, array $context = array())

Logs with an arbitrary level.

Parameters

mixed $level
string $message
array $context

Return Value

null

at line 54
public __construct(InputInterface $input, OutputInterface $output, HelperSet $helperSet)

Constructor.

Parameters

InputInterface $input The input instance
OutputInterface $output The output instance
HelperSet $helperSet The helperSet instance

at line 71
public enableDebugging(float $startTime)

Parameters

float $startTime

at line 79
public bool isInteractive()

Is this input means interactive?

Return Value

bool

at line 87
public bool isDecorated()

Is this output decorated?

Return Value

bool

at line 95
public bool isVerbose()

Is this output verbose?

Return Value

bool

at line 103
public bool isVeryVerbose()

Is the output very verbose?

Return Value

bool

at line 111
public bool isDebug()

Is the output in debug verbosity?

Return Value

bool

at line 119
public write(string|array $messages, bool $newline = true, int $verbosity = self::NORMAL)

Writes a message to the output.

Parameters

string|array $messages The message as an array of lines or a single string
bool $newline Whether to add a newline or not
int $verbosity Verbosity level from the VERBOSITY_* constants

at line 127
public writeError(string|array $messages, bool $newline = true, int $verbosity = self::NORMAL)

Writes a message to the error output.

Parameters

string|array $messages The message as an array of lines or a single string
bool $newline Whether to add a newline or not
int $verbosity Verbosity level from the VERBOSITY_* constants

at line 174
public overwrite(string|array $messages, bool $newline = true, int $size = null, int $verbosity = self::NORMAL)

Overwrites a previous message to the output.

Parameters

string|array $messages The message as an array of lines or a single string
bool $newline Whether to add a newline or not
int $size The size of line
int $verbosity Verbosity level from the VERBOSITY_* constants

at line 182
public overwriteError(string|array $messages, bool $newline = true, int $size = null, int $verbosity = self::NORMAL)

Overwrites a previous message to the error output.

Parameters

string|array $messages The message as an array of lines or a single string
bool $newline Whether to add a newline or not
int $size The size of line
int $verbosity Verbosity level from the VERBOSITY_* constants

at line 235
public string ask(string|array $question, string $default = null)

Asks a question to the user.

Parameters

string|array $question The question to ask
string $default The default answer if none is given by the user

Return Value

string The user answer

Exceptions

RuntimeException If there is no data to read in the input stream

at line 247
public bool askConfirmation(string|array $question, bool $default = true)

Asks a confirmation to the user.

The question will be asked until the user answers by nothing, yes, or no.

Parameters

string|array $question The question to ask
bool $default The default answer if the user enters nothing

Return Value

bool true if the user has confirmed, false otherwise

at line 259
public mixed askAndValidate(string|array $question, callable $validator, null|int $attempts = null, mixed $default = null)

Asks for a value and validates the response.

The validator receives the data to validate. It must return the validated data when the data is valid and throw an exception otherwise.

Parameters

string|array $question The question to ask
callable $validator A PHP callback
null|int $attempts Max number of times to ask before giving up (default of null means infinite)
mixed $default The default answer if none is given by the user

Return Value

mixed

Exceptions

Exception When any of the validators return an error

at line 273
public string askAndHideAnswer(string $question)

Asks a question to the user and hide the answer.

Parameters

string $question The question to ask

Return Value

string The answer

at line 283
public int|string|array select(string|array $question, array $choices, bool|string $default, bool|int $attempts = false, string $errorMessage = 'Value "%s" is invalid', bool $multiselect = false)

Asks the user to select a value.

Parameters

string|array $question The question to ask
array $choices List of choices to pick from
bool|string $default The default answer if the user enters nothing
bool|int $attempts Max number of times to ask before giving up (false by default, which means infinite)
string $errorMessage Message which will be shown if invalid value from choice list would be picked
bool $multiselect Select more than one value separated by comma

Return Value

int|string|array The selected value or values (the key of the choices array)

Exceptions

InvalidArgumentException