Create a visually pleasing ASCII art table from 2 dimensional array data.
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this helper.
Cake\Console\ConsoleIo
ConsoleIo instance.
Constructor.
Add style tags
Calculate the column widths
Get the width of a cell exclusive of style tags.
Deletes a single config key.
Reads a config key.
Writes a config key.
Output a row.
Output a row separator.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Returns the config.
Returns the config for this specific key.
Output a table.
Sets the config.
__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])
Constructor.
Cake\Console\ConsoleIo
$io The ConsoleIo instance to use.
array<string, mixed>
$config optional The settings for this helper.
_addStyle(string $text, string $style): string
Add style tags
string
$text The text to be surrounded
string
$style The style to be applied
string
_calculateWidths(array $rows): array<int>
Calculate the column widths
array
$rows The rows on which the columns width will be calculated on.
array<int>
_cellWidth(string $text): int
Get the width of a cell exclusive of style tags.
string
$text The text to calculate a width for.
int
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
void
Cake\Core\Exception\CakeException
_render(array $row, array<int> $widths, array<string, mixed> $options = []): void
Output a row.
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.
void
_rowSeparator(array<int> $widths): void
Output a row separator.
array<int>
$widths The widths of each column to output.
void
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(string|null $key = null, mixed $default = null): mixed
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
getConfigOrFail(string $key): mixed
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
InvalidArgumentException
output(array $args): void
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
$args The data to render out.
void
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
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.
$this
Cake\Core\Exception\CakeException
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for this helper.
array<string, mixed>
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.4/class-Cake.Shell.Helper.TableHelper.html