Класс 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.
http://api.cakephp.org/2.8/class-ProgressShellHelper.html