Класс ProgressHelper

draw()source public

draw( )

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

increment()source public

increment( integer $num 1 )

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

Параметры

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

Значение, на которое увеличивается прогресс.

init()source public

init( array $args [] )

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

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

Параметры

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

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

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

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

boolean|строка $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

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

boolean $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 Сам объект.