Documentation

ProgressIndicator
in package

Tags
author

Kevin Bond kevinbond@gmail.com

Table of Contents

$format  : mixed
$formats  : mixed
$formatters  : mixed
$indicatorChangeInterval  : mixed
$indicatorCurrent  : mixed
$indicatorUpdateTime  : mixed
$indicatorValues  : mixed
$message  : mixed
$output  : mixed
$started  : mixed
$startTime  : mixed
__construct()  : mixed
advance()  : mixed
Advances the indicator.
finish()  : mixed
Finish the indicator with message.
getFormatDefinition()  : string|null
Gets the format for a given name.
getPlaceholderFormatterDefinition()  : callable|null
Gets the placeholder formatter for a given name (including the delimiter char like %).
setMessage()  : mixed
Sets the current indicator message.
setPlaceholderFormatterDefinition()  : mixed
Sets a placeholder formatter for a given name.
start()  : mixed
Starts the indicator output.
determineBestFormat()  : string
display()  : mixed
getCurrentTimeInMilliseconds()  : float
initFormats()  : array<string|int, mixed>
initPlaceholderFormatters()  : array<string|int, mixed>
overwrite()  : mixed
Overwrites a previous message to the output.

Properties

Methods

__construct()

public __construct(OutputInterface $output[, string $format = null ][, int $indicatorChangeInterval = 100 ][, array<string|int, mixed>|null $indicatorValues = null ]) : mixed
Parameters
$output : OutputInterface
$format : string = null
$indicatorChangeInterval : int = 100

Change interval in milliseconds

$indicatorValues : array<string|int, mixed>|null = null

Animated indicator characters

Return values
mixed

advance()

Advances the indicator.

public advance() : mixed
Return values
mixed

finish()

Finish the indicator with message.

public finish( $message) : mixed
Parameters
$message :
Return values
mixed

getFormatDefinition()

Gets the format for a given name.

public static getFormatDefinition(string $name) : string|null
Parameters
$name : string
Return values
string|null

A format string

getPlaceholderFormatterDefinition()

Gets the placeholder formatter for a given name (including the delimiter char like %).

public static getPlaceholderFormatterDefinition(string $name) : callable|null
Parameters
$name : string
Return values
callable|null

A PHP callable

setMessage()

Sets the current indicator message.

public setMessage(string|null $message) : mixed
Parameters
$message : string|null
Return values
mixed

setPlaceholderFormatterDefinition()

Sets a placeholder formatter for a given name.

public static setPlaceholderFormatterDefinition(string $name, callable $callable) : mixed

This method also allow you to override an existing placeholder.

Parameters
$name : string
$callable : callable
Return values
mixed

start()

Starts the indicator output.

public start(string $message) : mixed
Parameters
$message : string
Return values
mixed

determineBestFormat()

private determineBestFormat() : string
Return values
string

getCurrentTimeInMilliseconds()

private getCurrentTimeInMilliseconds() : float
Return values
float

initFormats()

private static initFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

initPlaceholderFormatters()

private static initPlaceholderFormatters() : array<string|int, mixed>
Return values
array<string|int, mixed>

overwrite()

Overwrites a previous message to the output.

private overwrite(string $message) : mixed
Parameters
$message : string
Return values
mixed

Search results