StyleInterface Interface Reference

Inheritance diagram for StyleInterface:

Public Member Functions
	title ($message)
	section ($message)
	listing (array $elements)
	text ($message)
	success ($message)
	error ($message)
	warning ($message)
	note ($message)
	caution ($message)
	table (array $headers, array $rows)
	ask ($question, $default=null, $validator=null)
	askHidden ($question, $validator=null)
	confirm ($question, $default=true)
	choice ($question, array $choices, $default=null)
	newLine ($count=1)
	progressStart ($max=0)
	progressAdvance ($step=1)
	progressFinish ()

Detailed Description

Output style helpers.

Author

Kevin Bond kevin.nosp@m.bond.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Definition at line 19 of file StyleInterface.php.

Member Function Documentation

ask	(		$question,
			$default = null,
			$validator = null
	)

Asks a question.

Parameters

string	$question
string | null	$default
callable | null	$validator

Returns

string

Implemented in SymfonyStyle.

askHidden	(		$question,
			$validator = null
	)

Asks a question with the user input hidden.

Parameters

string	$question
callable | null	$validator

Returns

string

Implemented in SymfonyStyle.

caution

(

$message

)

Formats a caution admonition.

Parameters

string | array

$message

Implemented in SymfonyStyle.

choice	(		$question,
		array	$choices,
			$default = null
	)

Asks a choice question.

Parameters

string	$question
array	$choices
string | int | null	$default

Returns

string

Implemented in SymfonyStyle.

confirm	(		$question,
			$default = true
	)

Asks for confirmation.

Parameters

string	$question
bool	$default

Returns

bool

Implemented in SymfonyStyle.

error

(

$message

)

Formats an error result bar.

Parameters

string | array

$message

Implemented in SymfonyStyle.

listing

(

array

$elements

)

Formats a list.

Parameters

array

$elements

Implemented in SymfonyStyle.

newLine

(

$count = 1

)

Add newline(s).

Parameters

int

$count

The number of newlines

Implemented in SymfonyStyle, and OutputStyle.

note

(

$message

)

Formats a note admonition.

Parameters

string | array

$message

Implemented in SymfonyStyle.

progressAdvance

(

$step = 1

)

Advances the progress output X steps.

Parameters

int

$step

Number of steps to advance

Implemented in SymfonyStyle.

progressFinish

(

)

Finishes the progress output.

Implemented in SymfonyStyle.

progressStart

(

$max = 0

)

Starts the progress output.

Parameters

int

$max

Maximum steps (0 if unknown)

Implemented in SymfonyStyle.

section

(

$message

)

Formats a section title.

Parameters

string

$message

Implemented in SymfonyStyle.

success

(

$message

)

Formats a success result bar.

Parameters

string | array

$message

Implemented in SymfonyStyle.

table	(	array	$headers,
		array	$rows
	)

Formats a table.

Parameters

array	$headers
array	$rows

Implemented in SymfonyStyle.

text

(

$message

)

Formats informational text.

Parameters

string | array

$message

Implemented in SymfonyStyle.

title

(

$message

)

Formats a command title.

Parameters

string

$message

Implemented in SymfonyStyle.

warning

(

$message

)

Formats an warning result bar.

Parameters

string | array

$message

Implemented in SymfonyStyle.