Spec-Zone.ru › CakePHP 3.1

Класс Helper

Базовый класс для Помощников.

Помощники консоли позволяют упаковывать многократно используемые блоки логики вывода в консоль. Например, создание таблиц, полос прогресса или ASCII-искусства.

Cake\Console\Helper использует Cake\Core\InstanceConfigTrait

Непосредственные известные подклассы

Cake\Shell\Helper\ProgressHelper, Cake\Shell\Helper\TableHelper
Абстрактный
Пространство имён: Cake\Console
Расположен в Console/Helper.php

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

__constructsource public

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

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

Параметры

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

outputsource абстрактный public

output( array $args )

Этот метод должен выводить содержимое, используя $this->_io.

Параметры

массив $args
Аргументы для помощника.

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

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

Возвращает

mixed
смешанное значение

_configWritesource protected

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

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

Параметры

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

Исключения

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

configsource 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
Значение для установки.
boolean $merge необязательно true
Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

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

Исключения

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

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

Возвращает

mixed
Сам объект

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

$_defaultConfigsource

protected массив

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

[]

$_iosource

protected Cake\Console\ConsoleIo

Экземпляр ConsoleIo.

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

$_configsource

protected массив

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

[]

$_configInitializedsource

protected boolean

Указатель на то, была ли конфигурация уже сконфигурирована по умолчанию

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.Console.Helper.html

Spec-Zone.ru

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