Класс ProgressShellHelper

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

ProgressShellHelper

Авторские права: Авторские права (c) Cake Software Foundation, Inc. (http://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–2016 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.9/class-ProgressShellHelper.html