Gitee
\
App
HttpController
Api
Lib
Process
Redis
Composer
Autoload
CaBundle
Command
Config
Console
DependencyResolver
Operation
Downloader
EventDispatcher
Exception
Installer
IO
Json
Package
Archiver
Comparer
Dumper
LinkConstraint
Loader
Version
Plugin
Capability
Question
Repository
Pear
Vcs
Script
SelfUpdate
Semver
Constraint
Spdx
Util
XdebugHandler
Cron
Tests
EasySwoole
FastRoute
DataGenerator
Dispatcher
RouteParser
JsonSchema
Constraints
TypeCheck
Entity
Exception
Iterator
Uri
Retrievers
PhpParser
Builder
Comment
ErrorHandler
Lexer
Node
Expr
AssignOp
BinaryOp
Cast
Name
Scalar
MagicConst
Stmt
TraitUseAdaptation
NodeVisitor
Parser
PrettyPrinter
Serializer
Unserializer
Psr
Log
Test
Seld
JsonLint
PharUtils
SuperClosure
Analyzer
Visitor
Exception
Swoole
Connection
Coroutine
Http
Http2
Mysql
Http
Http2
Mysql
Redis
Server
WebSocket
Symfony
Component
Console
Command
CommandLoader
DependencyInjection
Descriptor
Event
EventListener
Exception
Formatter
Helper
Input
Logger
Output
Question
Style
Tester
Tests
Command
CommandLoader
DependencyInjection
Descriptor
EventListener
Fixtures
Formatter
Helper
Input
Logger
Output
Style
Tester
Filesystem
Exception
Tests
Fixtures
MockStream
Finder
Comparator
Exception
Iterator
Tests
Comparator
Iterator
Process
Exception
Pipes
Tests
Polyfill
Ctype
Mbstring
Php56
Util

\Symfony\Component\Console\FormatterOutputFormatter

Formatter class for console output.

Summary

Methods
Properties
Constants
escape()
__construct()
setDecorated()
isDecorated()
setStyle()
hasStyle()
getStyle()
format()
getStyleStack()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
createStyleFromString()
applyCurrentStyle()
$decorated
$styles
$styleStack
N/A

Properties

$decorated

$decorated :

Type

$styles

$styles :

Type

$styleStack

$styleStack :

Type

Methods

escape()

escape(string  $text) : string

Escapes "<" special char in given text.

Parameters

string $text

Text to escape

Returns

string —

Escaped text

__construct()

__construct(boolean  $decorated = false, array<mixed,\Symfony\Component\Console\Formatter\OutputFormatterStyleInterface>  $styles = array())

Initializes console output formatter.

Parameters

boolean $decorated

Whether this formatter should actually decorate strings
array<mixed,\Symfony\Component\Console\Formatter\OutputFormatterStyleInterface> $styles

Array of "name => FormatterStyle" instances

setDecorated()

setDecorated(boolean  $decorated)

Sets the decorated flag.

Parameters

boolean $decorated

Whether to decorate the messages or not

isDecorated()

isDecorated() : boolean

Gets the decorated flag.

Returns

boolean —

true if the output will decorate messages, false otherwise

hasStyle()

hasStyle(string  $name) : boolean

Checks if output formatter has style with specified name.

Parameters

string $name

Returns

boolean

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

createStyleFromString()

createStyleFromString(\Symfony\Component\Console\Formatter\string  $string) : \Symfony\Component\Console\Formatter\OutputFormatterStyle|false

Tries to create new style instance from string.

Parameters

\Symfony\Component\Console\Formatter\string $string

Returns

\Symfony\Component\Console\Formatter\OutputFormatterStyle|false —

False if string is not format string

applyCurrentStyle()

applyCurrentStyle(\Symfony\Component\Console\Formatter\string  $text)

Applies current style from stack to text, if must be applied.

Parameters

\Symfony\Component\Console\Formatter\string $text