PHP Класс Symfony\Component\Console\Formatter\OutputFormatter

Автор: Konstantin Kudryashov ([email protected])

Наследование: implements Symfony\Component\Console\Formatter\OutputFormatterInterface

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

Метод	Описание
__construct ( boolean $decorated = false, array $styles = [] )	Initializes console output formatter.
escape ( string $text ) : string	Escapes "<" special char in given text.
escapeTrailingBackslash ( string $text ) : string	Escapes trailing "\" in given text.
format ( string $message ) : string	Formats a message according to the given styles.
getStyle ( string $name ) : Symfony\Component\Console\Formatter\OutputFormatterStyleInterface	Gets style options from style with specified name.
getStyleStack ( ) : Symfony\Component\Console\Formatter\OutputFormatterStyleStack
hasStyle ( string $name ) : boolean	Checks if output formatter has style with specified name.
isDecorated ( ) : boolean	Gets the decorated flag.
setDecorated ( boolean $decorated )	Sets the decorated flag.
setStyle ( string $name, Symfony\Component\Console\Formatter\OutputFormatterStyleInterface $style )	Sets a new style.

Метод	Описание
applyCurrentStyle ( string $text ) : string	Applies current style from stack to text, if must be applied.
createStyleFromString ( string $string ) : Symfony\Component\Console\Formatter\OutputFormatterStyle \| boolean	Tries to create new style instance from string.

Initializes console output formatter.

public __construct ( boolean $decorated = false, array $styles = [] )
$decorated	boolean	Whether this formatter should actually decorate strings
$styles	array	Array of "name => FormatterStyle" instances

Escapes "<" special char in given text.

public static escape ( string $text ) : string
$text	string	Text to escape
Результат	string	Escaped text

Escapes trailing "\" in given text.

public static escapeTrailingBackslash ( string $text ) : string
$text	string	Text to escape
Результат	string	Escaped text

Formats a message according to the given styles.

public format ( string $message ) : string
$message	string	The message to style
Результат	string	The styled message

Gets style options from style with specified name.

public getStyle ( string $name ) : Symfony\Component\Console\Formatter\OutputFormatterStyleInterface
$name	string
Результат	Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

public getStyleStack ( ) : Symfony\Component\Console\Formatter\OutputFormatterStyleStack
Результат	Symfony\Component\Console\Formatter\OutputFormatterStyleStack

Checks if output formatter has style with specified name.

public hasStyle ( string $name ) : boolean
$name	string
Результат	boolean

Gets the decorated flag.

public isDecorated ( ) : boolean
Результат	boolean	true if the output will decorate messages, false otherwise

Sets the decorated flag.

public setDecorated ( boolean $decorated )
$decorated	boolean	Whether to decorate the messages or not

Sets a new style.

public setStyle ( string $name, Symfony\Component\Console\Formatter\OutputFormatterStyleInterface $style )
$name	string	The style name
$style	Symfony\Component\Console\Formatter\OutputFormatterStyleInterface	The style instance