Documentation

OutputFormatterInterface

Formatter interface for console output.

Tags
author

Konstantin Kudryashov ever.zet@gmail.com

Table of Contents

Methods

format()  : string
Formats a message according to the given styles.
getStyle()  : OutputFormatterStyleInterface
Gets style options from style with specified name.
hasStyle()  : bool
Checks if output formatter has style with specified name.
isDecorated()  : bool
Gets the decorated flag.
setDecorated()  : mixed
Sets the decorated flag.
setStyle()  : mixed
Sets a new style.

Methods

format()

Formats a message according to the given styles.

public format(string $message) : string
Parameters
$message : string

The message to style

Return values
string

The styled message

hasStyle()

Checks if output formatter has style with specified name.

public hasStyle(string $name) : bool
Parameters
$name : string
Return values
bool

isDecorated()

Gets the decorated flag.

public isDecorated() : bool
Return values
bool

true if the output will decorate messages, false otherwise

setDecorated()

Sets the decorated flag.

public setDecorated(bool $decorated) : mixed
Parameters
$decorated : bool

Whether to decorate the messages or not


        
On this page

Search results