Class ConsoleIo

__construct()source public

__construct( Cake\Console\ConsoleOutput $out = null , Cake\Console\ConsoleOutput $err = null , Cake\Console\ConsoleInput $in = null , Cake\Console\HelperRegistry $helpers = null )

Constructor

Parameters

Cake\Console\ConsoleOutput $out optional null

A ConsoleOutput object for stdout.

Cake\Console\ConsoleOutput $err optional null

A ConsoleOutput object for stderr.

Cake\Console\ConsoleInput $in optional null

A ConsoleInput object for stdin.

Cake\Console\HelperRegistry $helpers optional null

A HelperRegistry instance

_getInput()source protected

_getInput( string $prompt , string|null $options , string|null $default )

Prompts the user for input, and returns it.

Parameters

string $prompt

Prompt text.

string|null $options

String of options. Pass null to omit.

string|null $default

Default input value. Pass null to omit.

Returns

string
Either the default value, or the user-provided input.

ask()source public

ask( string $prompt , string|null $default = null )

Prompts the user for input, and returns it.

Parameters

string $prompt

Prompt text.

string|null $default optional null

Default input value.

Returns

mixed
Either the default value, or the user-provided input.

askChoice()source public

askChoice( string $prompt , string|array $options , string|null $default = null )

Prompts the user for input based on a list of options, and returns it.

Parameters

string $prompt

Prompt text.

string|array $options

Array or string of options.

string|null $default optional null

Default input value.

Returns

mixed
Either the default value, or the user-provided input.

createFile()source public

createFile( string $path , string $contents , boolean $forceOverwrite = false )

Create a file at the given path.

This method will prompt the user if a file will be overwritten. Setting forceOverwrite to true will suppress this behavior and always overwrite the file.

If the user replies a subsequent forceOverwrite parameters will be coerced to true and all files will be overwritten.

Parameters

string $path

The path to create the file at.

string $contents

The contents to put into the file.

boolean $forceOverwrite optional false

Whether or not the file should be overwritten. If true, no question will be asked about whether or not to overwrite existing files.

Returns

boolean
Success.

Throws

Cake\Console\Exception\StopException

When q is given as an answer to whether or not a file should be overwritten.

err()source public

err( string|array $message = '' , integer $newlines = 1 )

Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.

Parameters

string|array $message optional ''

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

Returns

integer|boolean
The number of bytes returned from writing to stderr.

error()source public

error( string|array|null $message = null , integer $newlines = 1 )

Convenience method for err() that wraps message between tag

Parameters

string|array|null $message optional null

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

Returns

integer|boolean
The number of bytes returned from writing to stderr.

See

https://book.cakephp.org/3.0/en/console-and-shells.html#ConsoleIo::err

helper()source public

helper( string $name , array $settings = [] )

Render a Console Helper

Create and render the output for a helper object. If the helper object has not already been loaded, it will be loaded and constructed.

Parameters

string $name

The name of the helper to render

array $settings optional []

Configuration data for the helper.

Returns

Cake\Console\Helper
The created helper instance.

hr()source public

hr( integer $newlines = 0 , integer $width = 79 )

Outputs a series of minus characters to the standard output, acts as a visual separator.

Parameters

integer $newlines optional 0

Number of newlines to pre- and append

integer $width optional 79

Width of the line, defaults to 79

info()source public

info( string|array|null $message = null , integer $newlines = 1 , integer $level = self::NORMAL )

Convenience method for out() that wraps message between tag

Parameters

string|array|null $message optional null

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

integer $level optional self::NORMAL

The message's output level, see above.

Returns

integer|boolean
The number of bytes returned from writing to stdout.

See

https://book.cakephp.org/3.0/en/console-and-shells.html#ConsoleIo::out

level()source public

level( null|integer $level = null )

Get/set the current output level.

Parameters

null|integer $level optional null

The current output level.

Returns

integer
The current output level.

nl()source public

nl( integer $multiplier = 1 )

Returns a single or multiple linefeeds sequences.

Parameters

integer $multiplier optional 1

Number of times the linefeed sequence should be repeated

Returns

string

out()source public

out( string|array $message = '' , integer $newlines = 1 , integer $level = self::NORMAL )

Outputs a single or multiple messages to stdout. If no parameters are passed outputs just a newline.

Output levels

There are 3 built-in output level. ConsoleIo::QUIET, ConsoleIo::NORMAL, ConsoleIo::VERBOSE. The verbose and quiet output levels, map to the verbose and quiet output switches present in most shells. Using ConsoleIo::QUIET for a message means it will always display. While using ConsoleIo::VERBOSE means it will only display when verbose output is toggled.

Parameters

string|array $message optional ''

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

integer $level optional self::NORMAL

The message's output level, see above.

Returns

integer|boolean
The number of bytes returned from writing to stdout.

outputAs()source public deprecated

outputAs( integer $mode )

Change the output mode of the stdout stream

Deprecated

3.5.0 Use setOutputAs() instead.

Parameters

integer $mode

The output mode.

See

\Cake\Console\ConsoleOutput::outputAs()

overwrite()source public

overwrite( array|string $message , integer $newlines = 1 , integer|null $size = null )

Overwrite some already output text.

Useful for building progress bars, or when you want to replace text already output to the screen with new text.

Warning You cannot overwrite text that contains newlines.

Parameters

array|string $message

The message to output.

integer $newlines optional 1

Number of newlines to append.

integer|null $size optional null

The number of bytes to overwrite. Defaults to the length of the last message output.

quiet()source public

quiet( string|array $message , integer $newlines = 1 )

Output at all levels.

Parameters

string|array $message

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

Returns

integer|boolean
The number of bytes returned from writing to stdout.

setLoggers()source public

setLoggers( integer|boolean $enable )

Connects or disconnects the loggers to the console output.

Used to enable or disable logging stream output to stdout and stderr If you don't wish all log output in stdout or stderr through Cake's Log class, call this function with $enable=false.

Parameters

integer|boolean $enable

Use a boolean to enable/toggle all logging. Use one of the verbosity constants (self::VERBOSE, self::QUIET, self::NORMAL) to control logging levels. VERBOSE enables debug logs, NORMAL does not include debug logs, QUIET disables notice, info and debug logs.

setOutputAs()source public

setOutputAs( integer $mode )

Change the output mode of the stdout stream

Parameters

integer $mode

The output mode.

See

\Cake\Console\ConsoleOutput::setOutputAs()

styles()source public

styles( string|null $style = null , array|boolean|null $definition = null )

Add a new output style or get defined styles.

Parameters

string|null $style optional null

The style to get or create.

array|boolean|null $definition optional null

The array definition of the style to change or create a style or false to remove a style.

Returns

mixed

If you are getting styles, the style or null will be returned. If you are creating/modifying styles true will be returned.

See

\Cake\Console\ConsoleOutput::styles()

success()source public

success( string|array|null $message = null , integer $newlines = 1 , integer $level = self::NORMAL )

Convenience method for out() that wraps message between tag

Parameters

string|array|null $message optional null

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

integer $level optional self::NORMAL

The message's output level, see above.

Returns

integer|boolean
The number of bytes returned from writing to stdout.

See

https://book.cakephp.org/3.0/en/console-and-shells.html#ConsoleIo::out

verbose()source public

verbose( string|array $message , integer $newlines = 1 )

Output at the verbose level.

Parameters

string|array $message

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

Returns

integer|boolean
The number of bytes returned from writing to stdout.

warning()source public

warning( string|array|null $message = null , integer $newlines = 1 )

Convenience method for err() that wraps message between tag

Parameters

string|array|null $message optional null

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

Returns

integer|boolean
The number of bytes returned from writing to stderr.

See

https://book.cakephp.org/3.0/en/console-and-shells.html#ConsoleIo::err

wrapMessageWithType()source protected

wrapMessageWithType( string $messageType , string|array $message )

Wraps a message with a given message type, e.g.

Parameters

string $messageType

The message type, e.g. "warning".

string|array $message

The message to wrap.

Returns

array|string
The message wrapped with the given message type.

self::NORMAL

false