Spec-Zone.ru › CakePHP 3.1

Класс TableHelper

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

Cake\Console\Helper использует Cake\Core\InstanceConfigTrait
Extended by Cake\Shell\Helper\TableHelper
Пространство имён: Cake\Shell\Helper
Расположение Shell/Helper/TableHelper.php

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

_addStyleисходный код защищённый

_addStyle( string $text , string $style )

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

Параметры

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

Возвращает

string
строка

_calculateWidthsисходный код защищённый

_calculateWidths( array $rows )

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

Параметры

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

Возвращает

array
массив

_renderисходный код защищённый

_render( array $row , array $widths , array $options [] )

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

Параметры

массив $row
Строка для вывода.
массив $widths
Ширина каждого столбца для вывода.
массив $options необязательно []
Опции для передачи.

_rowSeparatorисходный код защищённый

_rowSeparator( array $widths )

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

Параметры

массив $widths
Ширина каждого столбца для вывода.

outputисходный код публичный

output( array $rows )

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

Параметры

массив $rows
Данные для рендеринга.

Методы, унаследованные от Cake\Console\Helper

__constructисходный код публичный

__construct( Cake\Console\ConsoleIo $io , array $config [] )

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

Параметры

Cake\Console\ConsoleIo $io
Экземпляр ConsoleIo для использования.
массив $config необязательно []
Настройки для данного помощника.

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDeleteисходный код защищённый

_configDelete( string $key )

Удаляет единственный ключ конфигурации

Параметры

строка $key
Ключ для удаления.

Исключения

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

_configReadисходный код защищённый

_configRead( string|null $key )

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

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWriteисходный код защищённый

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

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

Параметры

строка|массив $key
Ключ для записи.
смешанный тип $value
Значение для записи.
логическое значение|строка $merge необязательно false
True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.

Исключения

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

configисходный код публичный

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
Производить рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

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

configShallowисходный код публичный

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
Значение для установки.

Возвращает

mixed
Сам объект.

Резюме свойств

$_defaultConfigисходный код

защищённый массив

Настройки по умолчанию для данного помощника.

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

Наследуемые свойства из Cake\Console\Helper

$_ioисходный код

защищённый Cake\Console\ConsoleIo

Экземпляр ConsoleIo.

Свойства, используемые из Cake\Core\InstanceConfigTrait

$_configисходный код

защищённый массив

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

[]

$_configInitializedисходный код

защищённый логическое значение

Является ли свойство config уже настроенным значениями по умолчанию

false

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Shell.Helper.TableHelper.html

Spec-Zone.ru

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