Class TableHelper

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

Пространство имён: Cake\Shell\Helper

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

$_config protected

array<string, mixed>

Конфигурация во время выполнения
$_configInitialized protected

bool

Указывает, была ли свойство config уже настроена по умолчанию
$_defaultConfig protected

array<string, mixed>

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

Cake\Console\ConsoleIo

Экземпляр ConsoleIo.

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

__construct() public

Конструктор.
_addStyle() protected

Добавить теги стиля
_calculateWidths() protected

Рассчитать ширину столбцов
_cellWidth() protected

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

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_render() protected

Вывести строку.
_rowSeparator() protected

Вывести разделитель строк.
configShallow() public

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
output() public

Вывод таблицы.
setConfig() public

Устанавливает конфигурацию.

Подробное описание методов

__construct() public

__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])

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

Параметры

Cake\Console\ConsoleIo $io: Экземпляр ConsoleIo для использования.
array<string, mixed> $config optional: Настройки для этого помощника.

_addStyle() protected

_addStyle(string $text, string $style): string

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

Параметры

string $text: Текст, который нужно обрамить.
string $style: Стиль, который нужно применить.

Возвращает

string

_calculateWidths() protected

_calculateWidths(array $rows): array<int>

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

Параметры

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

Возвращает

array<int>

_cellWidth() protected

_cellWidth(string $text): int

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

Параметры

string $text: Текст для вычисления ширины.

Возвращает

int

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

_configRead() protected

_configRead(string|null $key): mixed

Считывает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Записывает ключ конфигурации.

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
при попытке перезаписи существующей конфигурации

_render() protected

_render(array $row, array<int> $widths, array<string, mixed> $options = []): void

Вывод строки.

Параметры

array $row: Строка для вывода.
array<int> $widths: Ширина каждого столбца для вывода.
array<string, mixed> $options optional: Параметры для передачи.

Возвращает

void

_rowSeparator() protected

_rowSeparator(array<int> $widths): void

Вывод разделителя строк.

Параметры

array<int> $widths: Ширина каждого столбца для вывода.

Возвращает

void

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Объединить предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, если ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для указанного ключа.

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

output() public

output(array $args): void

Вывод таблицы.

Данные выводятся в соответствии с порядком значений в массиве. Ключи не используются для выравнивания данных.

Параметры

array $args: Данные для рендеринга.

Возвращает

void

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Производить ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Выбрасывает

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

Подробное описание свойств

`$_config` protected

Конфигурация во время выполнения

Тип

array<string, mixed>

`$_configInitialized` protected

Настройка свойства конфигурации уже выполнена с параметрами по умолчанию

Тип

bool

`$_defaultConfig` protected

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

Тип

array<string, mixed>

`$_io` protected

Экземпляр ConsoleIo.

Тип

Cake\Console\ConsoleIo

© 2005–present 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/4.3/class-Cake.Shell.Helper.TableHelper.html

Class TableHelper

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

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

__construct() public

_addStyle() protected

_calculateWidths() protected

_cellWidth() protected

_configDelete() protected

_configRead() protected

_configWrite() protected

_render() protected

_rowSeparator() protected

configShallow() public

getConfig() public

getConfigOrFail() public

output() public

setConfig() public

Подробное описание методов

__construct() public

Параметры

_addStyle() protected

Параметры

Возвращает

_calculateWidths() protected

Параметры

Возвращает

_cellWidth() protected

Параметры

Возвращает

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

_render() protected

Параметры

Возвращает

_rowSeparator() protected

Параметры

Возвращает

configShallow() public

Параметры

Возвращает

getConfig() public

Использование

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

output() public

Параметры

Возвращает

setConfig() public

Использование

Параметры

Возвращает

Выбрасывает

Подробное описание свойств

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

$_io protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$_io` protected