Класс 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 Истинно, чтобы выполнить рекурсивное объединение, «shallow» для простого объединения, ложно, чтобы перезаписать, по умолчанию ложно.
Выбрасывает
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']);
Параметры
- строка|массив|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->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this Сам объект.
Подробное описание свойств
$_defaultConfigsource
protected массив
Конфигурация по умолчанию для этого помощника.
[
'headers' => true,
'rowSeparator' => false,
'headerStyle' => 'info',
]
© 2005–2017 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.3/class-Cake.Shell.Helper.TableHelper.html