Create a visually pleasing ASCII art table from 2 dimensional array data.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this helper.
\Cake\Console\ConsoleIo
ConsoleIo instance.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
__construct(\Cake\Console\ConsoleIo $io, array $config)
Constructor.
\Cake\Console\ConsoleIo
$io The ConsoleIo instance to use.
array
$config optional The settings for this helper.
_addStyle(string $text, string $style)
Add style tags
string
$text The text to be surrounded
string
$style The style to be applied
string
_calculateWidths(array $rows)
Calculate the column widths
array
$rows The rows on which the columns width will be calculated on.
int[]
_cellWidth(?string $text)
Get the width of a cell exclusive of style tags.
string|null
$text The text to calculate a width for.
int
The width of the textual content in visible characters.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
_render(array $row, array $widths, array $options)
Output a row.
array
$row The row to output.
int[]
$widths The widths of each column to output.
array
$options optional Options to be passed.
_rowSeparator(array $widths)
Output a row separator.
int[]
$widths The widths of each column to output.
configShallow(mixed $key, mixed $value)
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(?string $key, mixed $default)
Returns the config.
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');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
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.
array
$rows The data to render out.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this helper.
array
ConsoleIo instance.
\Cake\Console\ConsoleIo
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Shell.Helper.TableHelper.html