Класс ProgressHelper

$this->helper('Progress')->output(['callback' => function ($progress) {
    // Do work
    $progress->increment();
});

draw()source public

draw( )

Отображение полосы выполнения на основе текущего состояния.

Возвращает

$this

increment()source public

increment( integer $num = 1 )

Увеличение значения выполнения.

Параметры

целое $num необязательно 1

Количество приращения прогресса.

Возвращает

$this

init()source public

init( array $args = [] )

Инициализация полосы выполнения.

• total Общее количество элементов в полосе выполнения. По умолчанию 100.
• width Ширина полосы выполнения. По умолчанию 80.

Параметры

массив $args необязательно []

Данные инициализации.

Возвращает

$this

output()source public

output( array $args )

Вывод полосы выполнения.

Принимает ряд параметров для настройки поведения:

• total Общее количество элементов в полосе выполнения. По умолчанию 100.
• width Ширина полосы выполнения. По умолчанию 80.
• callback Обратный вызов, который будет вызываться в цикле для продвижения полосы выполнения.

Параметры

массив $args

Аргументы/параметры для использования при выводе полосы выполнения.

__construct()source public

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

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

Параметры

Cake\Console\ConsoleIo $io

Экземпляр ConsoleIo для использования.

массив $config необязательно []

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

_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

Значение, возвращаемое, когда ключ не существует.

Возвращает

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

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

Параметры

строка|массив $key

Ключ для установки или массив с полными настройками.

смешанный|null $value необязательно null

Значение для установки.

логическое $merge необязательно true

Флаг для рекурсивного объединения или перезаписи существующей конфигурации, по умолчанию true.

Возвращает

$this

Выбрасывает

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