Spec-Zone.ru › CakePHP 3.3

Класс TableHelper

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

Cake\Console\Helper использует Cake\Core\InstanceConfigTrait
Расширяется 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

Истинно, чтобы выполнить рекурсивное объединение, «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']);

Параметры

строка|массив|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–2017 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/3.3/class-Cake.Shell.Helper.TableHelper.html

Spec-Zone.ru

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