Класс TableHelper

_addStyle()source protected

_addStyle( string $text , string $style )

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

Параметры

строка $text

Текст, который нужно обрамить

строка $style

Стиль, который нужно применить

Возвращает

строка

_calculateWidths()source protected

_calculateWidths( array $rows )

Вычислить ширину столбцов

Параметры

массив $rows

Строки, на основе которых будут вычисляться ширины столбцов.

Возвращает

массив

_cellWidth()source protected

_cellWidth( string $text )

Получить ширину ячейки, за исключением тегов стиля.

Параметры

строка $text

Текст, для которого нужно вычислить ширину.

Возвращает

целое число
Ширина текстового содержимого в видимых символах.

_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

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию 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

Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию 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');

Параметры

string|null $key необязательный null

Ключ для получения или null для всей конфигурации.

mixed $default необязательный null

Возвращаемое значение, если ключ не существует.

Возвращаемое значение

mixed
Значение конфигурации, которое читается.

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',
]