Spec-Zone.ru › CakePHP 3.2

Класс TableHelper

Создайте визуально привлекательную таблицу ASCII-арт из данных двумерного массива.

Cake\Console\Helper использует Cake\Core\InstanceConfigTrait
Extended by Cake\Shell\Helper\TableHelper
Пространство имён: Cake\Shell\Helper
Расположение: Shell/Helper/TableHelper.php

Краткое описание свойств

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого помощника.

Унаследованные свойства

  • _io _config, _configInitialized

Краткое описание методов

  • _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']);

Параметры

строка|массив|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–2016 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.
http://api.cakephp.org/3.2/class-Cake.Shell.Helper.TableHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API