Класс ProgressShellHelper

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

ProgressShellHelper

Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Helper/ProgressShellHelper.php

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

$_progress protected

integer
Текущий прогресс.
$_total protected

integer
Общее количество элементов для обработки.
$_width protected

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

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

_config, _configInitialized, _consoleOutput, _defaultConfig

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

draw() public
Отображение полосы прогресса на основе текущего состояния.
increment() public
Увеличение прогресса.
init() public
Инициализация полосы прогресса для использования.
output() public
Вывод полосы прогресса.

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

draw()source public

draw( )

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

increment()source public

increment( integer $num 1 )

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

Параметры

целое число $num необязательный 1: Количество прогресса для увеличения.

init()source public

init( array $args array() )

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

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

Параметры

массив $args необязательный array(): Данные инициализации.

output()source public

output( array $args )

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

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

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

Параметры

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

Исключения

RuntimeException

Методы, унаследованные от BaseShellHelper

__construct()source public

__construct( ConsoleOutput $consoleOutput , array $config array() )

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

Параметры

ConsoleOutput $consoleOutput: Экземпляр ConsoleOutput для использования.
массив $config необязательный array(): Настройки для данного помощника.

config()source public

config( null $config null )

Инициализация конфигурации и сохранение значений конфигурации

Параметры

null $config необязательный null: Значения конфигурации для установки

Возвращает

массив|

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

$_progresssource

protected целое число

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

$_totalsource

protected целое число

Общее количество элементов для обработки.

$_widthsource

protected целое число

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

© 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/2.10/class-ProgressShellHelper.html