Spec-Zone.ru › CakePHP 3.5

Класс TableHelper

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

Cake\Console\Helper использует Cake\Core\InstanceConfigTrait
Extended by 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

Истина для рекурсивного слияния, «поверхностное» для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключения

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

Параметры

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

Возвращает

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

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

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

$_defaultConfigsource

protected массив

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

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

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

Spec-Zone.ru

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