Class TableHelper
Create a visually pleasing ASCII art table from 2-dimensional array data.
Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Default config for this helper.
-
$_io protected
Cake\Console\ConsoleIoConsoleIo instance.
Method Summary
-
__construct() public
Constructor.
-
_addStyle() protected
Add style tags
-
_calculateWidths() protected
Calculate the column widths
-
_cellWidth() protected
Get the width of a cell exclusive of style tags.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_render() protected
Output a row.
-
_rowSeparator() protected
Output a row separator.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
output() public
Output a table.
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])Constructor.
Parameters
-
Cake\Console\ConsoleIo$io The ConsoleIo instance to use.
-
array<string, mixed>$config optional The settings for this helper.
_addStyle() ¶ protected
_addStyle(string $text, string $style): stringAdd style tags
Parameters
-
string$text The text to be surrounded
-
string$style The style to be applied
Returns
string_calculateWidths() ¶ protected
_calculateWidths(array $rows): array<int>Calculate the column widths
Parameters
-
array$rows The rows on which the column's width will be calculated on.
Returns
array<int>_cellWidth() ¶ protected
_cellWidth(string $text): intGet the width of a cell exclusive of style tags.
Parameters
-
string$text The text to calculate a width for.
Returns
intThe width of the textual content in visible characters.
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites a config key.
Parameters
-
array<string, mixed>|string$key Key to write to.
-
mixed$value Value to write.
-
string|bool$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_render() ¶ protected
_render(array $row, array<int> $widths, array<string, mixed> $options = []): voidOutput a row.
Parameters
-
array$row The row to output.
-
array<int>$widths The widths of each column to output.
-
array<string, mixed>$options optional Options to be passed.
Returns
void_rowSeparator() ¶ protected
_rowSeparator(array<int> $widths): voidOutput a row separator.
Parameters
-
array<int>$widths The widths of each column to output.
Returns
voidconfigShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge 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
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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 The key to get or null for the whole config.
-
mixed$default optional The return value when the key does not exist.
Returns
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string$key The key to get.
Returns
mixedConfiguration data at the named key
Throws
InvalidArgumentExceptionoutput() ¶ public
output(array $args): voidOutput 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$args The data to render out.
Returns
voidsetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets 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
-
array<string, mixed>|string$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.
Returns
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool