Класс 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

Истинно для рекурсивного слияния, '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']);

Устаревшее

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');

Параметры

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

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

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

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

Возвращает

mixed
Данные конфигурации по указанному ключу или 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',
]