SymfonyComponentConsoleFormatterOutputFormatterInterface

Formatter interface for console output.

Summary

No protected methods found
N/A
No private methods found
N/A
File
vendorSymfonyComponentConsoleFormatterOutputFormatterInterface.php
Package
Default

Tags

author

Konstantin Kudryashov ever.zet@gmail.com

api

Methods

setDecorated()

setDecorated(Boolean  $decorated) 

Sets the decorated flag.

Parameters

Boolean $decorated

Whether to decorate the messages or not

Tags

api

isDecorated()

isDecorated() : Boolean

Gets the decorated flag.

Returns

Boolean —

true if the output will decorate messages, false otherwise

Tags

api

setStyle()

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

Sets a new style.

Parameters

string $name

The style name

SymfonyComponentConsoleFormatterOutputFormatterStyleInterface $style

The style instance

Tags

api

hasStyle()

hasStyle(string  $name) : Boolean

Checks if output formatter has style with specified name.

Parameters

string $name

Returns

Boolean

Tags

api

getStyle()

getStyle(string  $name) : \Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

Gets style options from style with specified name.

Parameters

string $name

Returns

SymfonyComponentConsoleFormatterOutputFormatterStyleInterface

Tags

api

format()

format(string  $message) : string

Formats a message according to the given styles.

Parameters

string $message

The message to style

Returns

string —

The styled message

Tags

api