Класс TableHelper
Создаёт таблицу в виде приятного для чтения ASCII-изображения из данных двумерного массива.
- Cake\Console\Helper использует Cake\Core\InstanceConfigTrait
-
Cake\Shell\Helper\TableHelper
Краткое описание свойств
-
$_defaultConfigprotectedКонфигурация по умолчанию для этого помощника.array
Наследованные свойства
Краткое описание методов
- _addStyle() protectedДобавить теги стиля
- _calculateWidths() protectedВычисление ширины столбцов
- _render() protectedВывод строки.
- _rowSeparator() protectedВывод разделителя строк.
- output() publicВывод таблицы.
Подробное описание методов
_addStyle()source protected
_addStyle( string $text , string $style )
Добавить теги стиля
Параметры
- строка
$text - Текст, который нужно заключить
- строка
$style - Стиль, который нужно применить
Возвращает
строка_calculateWidths()source protected
_calculateWidths( array $rows )
Вычисление ширины столбцов
Параметры
- массив
$rows - Строки, на основе которых будут вычислены ширины столбцов.
Возвращает
массив_render()source protected
_render( array $row , array $widths , array $options [] )
Вывод строки.
Параметры
- массив
$row - Строка для вывода.
- массив
$widths - Ширина каждого столбца для вывода.
- массив
$optionsдополнительно [] - Опции, которые нужно передать.
_rowSeparator()source protected
_rowSeparator( array $widths )
Вывод разделителя строк.
Параметры
- массив
$widths - Ширина каждого столбца для вывода.
output()source public
output( array $rows )
Вывод таблицы.
Данные будут выведены в порядке их расположения в массиве. Ключи не будут использоваться для выравнивания данных.
Параметры
- массив
$rows - Данные, которые нужно отобразить.
Наследованные методы от Cake\Console\Helper
__construct()source public
__construct( Cake\Console\ConsoleIo $io , array $config [] )
Конструктор.
Параметры
-
Cake\Console\ConsoleIo$io - Экземпляр ConsoleIo, который нужно использовать.
- массив
$configдополнительно [] - Настройки для этого помощника.
Методы, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет отдельный ключ конфигурации.
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Читает ключ конфигурации.
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанное_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Записывает ключ конфигурации.
Параметры
- строка|массив
$key - Ключ для записи.
- смешанное
$value - Значение для записи.
- логическое|строка
$mergeдополнительно false Истина для рекурсивного слияния, «поверхностное» для простого слияния, ложь для перезаписи, по умолчанию ложь.
Исключения
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
config()source public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Получение/установка конфигурации.
Использование
Чтение всей конфигурации:
$this->config();
Чтение определённого значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определённого значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Устарело
3.4.0 используйте setConfig()/getConfig() вместо этого.Параметры
- строка|массив|null
$keyдополнительно null - Ключ для получения/установки или весь массив конфигураций.
- смешанное|null
$valueдополнительно null - Значение для установки.
- логическое
$mergeдополнительно true - Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истина.
Возвращает
смешанноеЗначение конфигурации, которое читается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\Exceptionпри попытке установить недопустимый ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определённого значения:
$this->configShallow('key', $value); Установка вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанное|null
$valueдополнительно null - Значение для установки.
Возвращает
$this
getConfig()source public
getConfig( string|null $key null , mixed $default null )
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определённого значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
- строка|null
$keyдополнительно null - Ключ для получения или null для всей конфигурации.
- смешанное
$defaultдополнительно null - Возвращаемое значение, когда ключ не существует.
Возвращает
смешанноеЗначение конфигурации, которое читается.
setConfig()source public
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Устанавливает конфигурацию.
Использование
Установка определенного значения:
$this->setConfig('key', $value); Установка вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
- string|array
$key - Ключ для установки или полный массив конфигураций.
- mixed|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.
Возвращает
$this
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
Подробное описание свойств
$_defaultConfigsource
protected массив
Конфигурация по умолчанию для этого помощника.
[
'headers' => true,
'rowSeparator' => false,
'headerStyle' => 'info',
]
© 2005–2018 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/3.5/class-Cake.Shell.Helper.TableHelper.html