SMW\Utils\CliMsgFormatter Class Reference

Public Member Functions
	head ()
	wordwrap (array $lines=[])
	red (string $text)
	green (string $text)
	yellow (string $text)
	progress (int $i, int $total)
	progressCompact (int $i, int $total, ?int $current=null, ?int $last=null, ?int $remainingTime=null)
	setStartTime (int $startTime)
	remainingTime (int $i, int $total)
	elapsedTime ()
	section (string $title, int $indentLen=3, string $placeHolder='-', bool $reverse=false)
	twoColsOverride (string $firstCol, string $secondCol, int $indentLen=0, string $placeHolder=' ')
	twoLineOverride (string $firstLine, string $secondLine)
	twoCols (string $firstCol, string $secondCol, int $indentLen=0, string $placeHolder=' ')
	countDown (string $message, int $seconds)
	oneCol (string $oneCol, int $indentLen=0)
	getLen (string $key, int $indentLen=0)
	setFirstColLen (int $firstColLen)
	incrFirstColLen (int $len)
	getFirstColLen ()
	firstCol (string $firstCol, int $indentLen=0, int $expectedSecondColLen=0)
	positionCol (string $value, int $position=0, string $placeHolder=' ')
	secondCol (string $value, string $placeHolder=' ')

Public Attributes
const	OK = '✓'
const	FAILED = '✗'
const	MAX_LEN = 75

Detailed Description

GNU GPL v2+

Since

3.2

Author

mwjames

Member Function Documentation

countDown()

SMW\Utils\CliMsgFormatter::countDown	(	string	$message,
		int	$seconds
	)

Since

3.2

Parameters

string	$value
integer	$seconds

elapsedTime()

SMW\Utils\CliMsgFormatter::elapsedTime

(

)

Since

3.2

Returns

string

firstCol()

SMW\Utils\CliMsgFormatter::firstCol	(	string	$firstCol,
		int	$indentLen = 0,
		int	$expectedSecondColLen = 0
	)

Since

3.2

Parameters

string	$firstCol
integer	$indentLen
integer	$expectedSecondColLen

Returns

string

getFirstColLen()

SMW\Utils\CliMsgFormatter::getFirstColLen

(

)

Since

3.2

Returns

integer|null

getLen()

SMW\Utils\CliMsgFormatter::getLen	(	string	$key,
		int	$indentLen = 0
	)

Since

3.2

Parameters

string	$key
integer	$indentLen

Returns

integer

green()

SMW\Utils\CliMsgFormatter::green

(

string

$text

)

Since

3.2

Parameters

string

$string

Returns

string

head()

SMW\Utils\CliMsgFormatter::head

(

)

Since

3.2

Returns

string

incrFirstColLen()

SMW\Utils\CliMsgFormatter::incrFirstColLen

(

int

$len

)

Since

3.2

Parameters

integer

$len

oneCol()

SMW\Utils\CliMsgFormatter::oneCol	(	string	$oneCol,
		int	$indentLen = 0
	)

Since

3.2

Parameters

string	$oneCol
integer	$indentLen

Returns

string

positionCol()

SMW\Utils\CliMsgFormatter::positionCol	(	string	$value,
		int	$position = 0,
		string	$placeHolder = ' '
	)

Since

3.2

Parameters

string	$value
int	$position
string	$placeHolder

Returns

string

progress()

SMW\Utils\CliMsgFormatter::progress	(	int	$i,
		int	$total
	)

Since

3.2

Parameters

integer	$i
integer	$total

Returns

string

progressCompact()

SMW\Utils\CliMsgFormatter::progressCompact	(	int	$i,
		int	$total,
		?int	$current = null,
		?int	$last = null,
		?int	$remainingTime = null
	)

Since

3.2

Parameters

integer	$i
integer	$total
integer | null	$current
integer | null	$last
integer | null	$remainingTime

Returns

string

red()

SMW\Utils\CliMsgFormatter::red

(

string

$text

)

Since

3.2

Parameters

string

$string

Returns

string

remainingTime()

SMW\Utils\CliMsgFormatter::remainingTime	(	int	$i,
		int	$total
	)

Since

3.2

Parameters

integer	$i
integer	$total

Returns

string

secondCol()

SMW\Utils\CliMsgFormatter::secondCol	(	string	$value,
		string	$placeHolder = ' '
	)

Since

3.2

Parameters

string	$value
string	$placeHolder

Returns

string

section()

SMW\Utils\CliMsgFormatter::section	(	string	$title,
		int	$indentLen = 3,
		string	$placeHolder = '-',
		bool	$reverse = false
	)

Since

3.2

Parameters

string	$title
int	$indentLen
string	$placeHolder
bool	$reverse

Returns

string

setFirstColLen()

SMW\Utils\CliMsgFormatter::setFirstColLen

(

int

$firstColLen

)

Since

3.2

Parameters

integer

$firstColLen

setStartTime()

SMW\Utils\CliMsgFormatter::setStartTime

(

int

$startTime

)

Since

3.2

Parameters

int

$startTime

twoCols()

SMW\Utils\CliMsgFormatter::twoCols	(	string	$firstCol,
		string	$secondCol,
		int	$indentLen = 0,
		string	$placeHolder = ' '
	)

Since

3.2

Parameters

string	$firstCol
string	$secondCol
integer	$indentLen
string	$placeHolder

Returns

string

twoColsOverride()

SMW\Utils\CliMsgFormatter::twoColsOverride	(	string	$firstCol,
		string	$secondCol,
		int	$indentLen = 0,
		string	$placeHolder = ' '
	)

Since

3.2

Parameters

string	$firstCol
string	$secondCol
integer	$indentLen
string	$placeHolder

Returns

string

twoLineOverride()

SMW\Utils\CliMsgFormatter::twoLineOverride	(	string	$firstLine,
		string	$secondLine
	)

Since

3.2

Parameters

string	$firstLine
string	$secondLine

Returns

string

wordwrap()

SMW\Utils\CliMsgFormatter::wordwrap

(

array

$lines = []

)

Since

3.2

Parameters

array

$lines

Returns

string

yellow()

SMW\Utils\CliMsgFormatter::yellow

(

string

$text

)

Since

3.2

Parameters

string

$string

Returns

string

Member Data Documentation

MAX_LEN

const SMW\Utils\CliMsgFormatter::MAX_LEN = 75

Max length of the CLI display

---

The documentation for this class was generated from the following file:

• CliMsgFormatter.php