Spec-Zone.ru › CakePHP 4.2

Класс ProgressHelper

Создайте полосу прогресса с помощью предоставленного обратного вызова.

Использование

К ProgressHelper можно получить доступ из оболочек с помощью метода helper()

$this->helper('Progress')->output(['callback' => function ($progress) {
    // Do work
    $progress->increment();
});
Пространство имен: Cake\Shell\Helper

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

  • $_config protected
    array

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

  • $_configInitialized protected
    bool

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

  • $_defaultConfig protected
    array

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

  • $_io protected
    Cake\Console\ConsoleIo

    Экземпляр ConsoleIo.

  • $_progress protected
    int|float

    Текущий прогресс.

  • $_total protected
    int

    Общее количество 'элементов', по которым необходимо пройти прогресс.

  • $_width protected
    int

    Ширина полосы.

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

  • __construct() public

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

  • _configDelete() protected

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

  • _configRead() protected

    Считывает ключ конфигурации.

  • _configWrite() protected

    Записывает ключ конфигурации.

  • configShallow() public

    Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

  • draw() public

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

  • getConfig() public

    Возвращает конфигурацию.

  • getConfigOrFail() public

    Возвращает конфигурацию для данного ключа.

  • increment() public

    Увеличивает полосу прогресса.

  • init() public

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

  • output() public

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

  • setConfig() public

    Устанавливает конфигурацию.

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

__construct() public 

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

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

Параметры

Cake\Console\ConsoleIo $io

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

array $config optional

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

_configDelete() protected 

_configDelete(string $key): void

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

Параметры

string $key

Ключ для удаления.

Возвращает

void

Исключения

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

_configRead() protected 

_configRead(string|null $key): mixed

Считывает ключ конфигурации.

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite() protected 

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

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

bool|string $merge optional

True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

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

configShallow() public 

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

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

mixed|null $value optional

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

Возвращает

$this

draw() public 

draw(): $this

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

Возвращает

$this

getConfig() public 

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional

Ключ для получения или null для всей конфигурации.

mixed $default optional

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

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для данного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

increment() public 

increment(int|float $num = 1): $this

Увеличивает полосу прогресса.

Параметры

int|float $num optional

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

Возвращает

$this

init() public 

init(array $args = []): $this

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

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

Параметры

array $args optional

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

Возвращает

$this

output() public 

output(array $args): void

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

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

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

Параметры

array $args

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

Возвращает

void

setConfig() public 

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

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

mixed|null $value optional

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

bool $merge optional

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

Возвращает

$this

Исключения

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

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

$_config protected

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

Тип

array

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

Конфигурация по умолчанию для данного помощника.

Тип

array

$_io protected

Экземпляр ConsoleIo.

Тип

Cake\Console\ConsoleIo

$_progress protected

Текущая степень выполнения.

Тип

int|float

$_total protected

Общее количество элементов, по которым выполняется прогресс.

Тип

int

$_width protected

Ширина полосы прогресса.

Тип

int

© 2005–present 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/4.2/class-Cake.Shell.Helper.ProgressHelper.html

Spec-Zone.ru

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