PHP Класс ConsoleKit\Widgets\ProgressBar


$total = 100;
$progress = new ProgressBar($textWriter, $total);
for ($i = 0; $i < $total; $i++) {
    $progress->incr();
    usleep(10000);
}
$progress->stop();

Наследование: extends AbstractWidget

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$showRemainingTime	boolean
$size	integer
$startTime	integer
$total	integer
$value	integer

Открытые методы

Метод	Описание
__construct ( ConsoleKit\TextWriter $writer = null, integer $total = 100, integer $size = 50, $showRemainingTime = true )
__toString ( )
getShowRemainingTime ( ) : boolean
getSize ( ) : integer
getValue ( ) : number
incr ( integer $increment = 1 ) : ProgressBar	Increments the value and calls {@see write()}
render ( ) : string	Generates the text to write for the current values
setShowRemainingTime ( boolean $show = true )
setSize ( integer $size ) : ProgressBar
setValue ( number $value )
start ( integer $total = 100 ) : ProgressBar
stop ( ) : ProgressBar	Writes a new line
write ( ) : ProgressBar	Writes the rendered progress bar to the text writer

Описание методов

__construct() публичный Метод

public __construct ( ConsoleKit\TextWriter $writer = null, integer $total = 100, integer $size = 50, $showRemainingTime = true )
$writer	ConsoleKit\TextWriter
$total	integer
$size	integer

__toString() публичный Метод

public __toString ( )

getShowRemainingTime() публичный Метод

public getShowRemainingTime ( ) : boolean
Результат	boolean

getSize() публичный Метод

public getSize ( ) : integer
Результат	integer

getValue() публичный Метод

public getValue ( ) : number
Результат	number

incr() публичный Метод

Increments the value and calls {@see write()}

public incr ( integer $increment = 1 ) : ProgressBar
$increment	integer
Результат	ProgressBar

render() публичный Метод

Generates the text to write for the current values

public render ( ) : string
Результат	string

setShowRemainingTime() публичный Метод

public setShowRemainingTime ( boolean $show = true )
$show	boolean

setSize() публичный Метод

public setSize ( integer $size ) : ProgressBar
$size	integer
Результат	ProgressBar

setValue() публичный Метод

public setValue ( number $value )
$value	number

start() публичный Метод

public start ( integer $total = 100 ) : ProgressBar
$total	integer
Результат	ProgressBar

stop() публичный Метод

Writes a new line

public stop ( ) : ProgressBar
Результат	ProgressBar

write() публичный Метод

Writes the rendered progress bar to the text writer

public write ( ) : ProgressBar
Результат	ProgressBar

Описание свойств

$showRemainingTime защищенное свойство

protected bool $showRemainingTime
Результат	boolean

$size защищенное свойство

protected int $size
Результат	integer

$startTime защищенное свойство

protected int $startTime
Результат	integer

$total защищенное свойство

protected int $total
Результат	integer

$value защищенное свойство

protected int $value
Результат	integer