_addStyle()source protected

_addStyle( string $text , string $style )

Add style tags

Parameters

string $text

The text to be surrounded

string $style

The style to be applied

Returns

string

_calculateWidths()source protected

_calculateWidths( array $rows )

Calculate the column widths

Parameters

array $rows

The rows on which the columns width will be calculated on.

Returns

array

_cellWidth()source protected

_cellWidth( string $text )

Get the width of a cell exclusive of style tags.

Parameters

string $text

The text to calculate a width for.

Returns

integer
The width of the textual content in visible characters.

_render()source protected

_render( array $row , array $widths , array $options = [] )

Output a row.

Parameters

array $row

The row to output.

array $widths

The widths of each column to output.

array $options optional []

Options to be passed.

_rowSeparator()source protected

_rowSeparator( array $widths )

Output a row separator.

Parameters

array $widths

The widths of each column to output.

output()source public

output( array $rows )

Output a table.

Data will be output based on the order of the values in the array. The keys will not be used to align data.

Parameters

array $rows

The data to render out.

__construct()source public

__construct( Cake\Console\ConsoleIo $io , array $config = [] )

Constructor.

Parameters

Cake\Console\ConsoleIo $io

The ConsoleIo instance to use.

array $config optional []

The settings for this helper.

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null

The key to get/set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

Returns

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional null

The key to get or null for the whole config.

mixed $default optional null

The return value when the key does not exist.

Returns

mixed
Configuration data at the named key or null if the key does not exist.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

[
    'headers' => true,
    'rowSeparator' => false,
    'headerStyle' => 'info',
]