Класс ProgressHelper

drawsource public

draw( )

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

incrementsource public

increment( integer $num 1 )

Увеличить значение прогресса.

Параметры

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

Количество прогресса, на которое нужно увеличить.

initsource public

init( array $args [] )

Инициализировать полосу прогресса для использования.

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

Параметры

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

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

outputsource public

output( array $args )

Вывести полосу прогресса.

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

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

Параметры

массив $args

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

__constructsource public

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

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

Параметры

Cake\Console\ConsoleIo $io

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

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

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

_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

Значение для записи.

логическое значение|строка $merge необязательный 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

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

логическое значение $merge необязательный 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
Сам объект $this.

[]

[]

false