CloudCastle Cli API

Spinner
in package

FinalYes

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

Каждый вызов self::tick() перерисовывает следующий кадр на месте (возврат каретки \r); self::finish() стирает индикатор и выводит итоговое сообщение.

Table of Contents

Methods

__construct()  : mixed
finish()  : void
Завершить анимацию: стереть индикатор и вывести сообщение.
tick()  : void
Отрисовать следующий кадр анимации.

Methods

__construct()

public __construct(Writer $output[, string $label = '' ]) : mixed
Parameters
$output : Writer

приёмник вывода

$label : string = ''

подпись рядом с индикатором

finish()

Завершить анимацию: стереть индикатор и вывести сообщение.

public finish([string $message = '' ]) : void
Parameters
$message : string = ''

итоговое сообщение (пустое — просто стереть)

tick()

Отрисовать следующий кадр анимации.

public tick() : void
On this page

Search results