Spec-Zone.ru › CakePHP 3.3

Класс Helper

Базовый класс для Helpers.

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

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

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

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

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

  • $_defaultConfig protected
    array
    Значения по умолчанию для этого помощника.
  • $_io protected
    Cake\Console\ConsoleIo
    Экземпляр ConsoleIo.

Унаследованные свойства

  • _config, _configInitialized

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

  • __construct() public
    Конструктор.
  • output() abstract public
    Этот метод должен выводить содержимое, используя $this->_io.

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

__construct()source public

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

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

Параметры

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

output()source abstract public

output( array $args )

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

Параметры

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

Методы, используемые из 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 массив

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

[]

$_iosource

protected Cake\Console\ConsoleIo

Экземпляр ConsoleIo.

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

Spec-Zone.ru

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