Class TableHelper
Create a visually pleasing ASCII art table from 2 dimensional array data.
- Cake\Console\Helper uses Cake\Core\InstanceConfigTrait
-
Cake\Shell\Helper\TableHelper
Properties summary
-
$_defaultConfigprotectedarrayDefault config for this helper.
Inherited Properties
Method Summary
-
_addStyle() protected
Add style tags -
_calculateWidths() protected
Calculate the column widths -
_cellWidth() protected
Get the width of a cell exclusive of style tags. -
_render() protected
Output a row. -
_rowSeparator() protected
Output a row separator. -
output() public
Output a table.
Method Detail
_addStyle() 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
_calculateWidths() protected ¶
_calculateWidths( array $rows )
Calculate the column widths
Parameters
- array $rows
- The rows on which the columns width will be calculated on.
Returns
_cellWidth() 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
The width of the textual content in visible characters.
_render() 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() protected ¶
_rowSeparator( array $widths )
Output a row separator.
Parameters
- array $widths
- The widths of each column to output.
Methods inherited from Cake\Console\Helper
__construct() 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.
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() 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
config() public ¶
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
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
Config value being read, or the object itself on write operations.
Throws
configShallow() 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() 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
Config value being read.
setConfig() 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
Properties detail
$_defaultConfig ¶
Default config for this helper.
[
'headers' => true,
'rowSeparator' => false,
'headerStyle' => 'info',
]