Класс TableHelper

_addStyle()source protected

_addStyle( string $text , string $style )

Добавление тегов стиля

Параметры

string $text

Текст, который будет заключён

string $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

Данные для рендеринга.

__construct()source public

__construct( Cake\Console\ConsoleIo $io , array $config = [] )

Конструктор.

Параметры

Cake\Console\ConsoleIo $io

Экземпляр ConsoleIo для использования.

массив $config необязательно []

Настройки для этого помощника.

_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 deprecated

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
При попытке установить недействительный ключ.

[
    'headers' => true,
    'rowSeparator' => false,
    'headerStyle' => 'info',
]