SymfonyComponentConsoleHelperFormatterHelper

The Formatter class provides helpers to format messages.

Summary

No public properties found
No constants found
No protected methods found
N/A
No private properties found
N/A
File
vendorSymfonyComponentConsoleHelperFormatterHelper.php
Package
Default
Class hierarchy
SymfonyComponentConsoleHelperFormatterHelper

Tags

author

Fabien Potencier fabien@symfony.com

Properties

$helperSet

$helperSet : 

Type

Inherited from
SymfonyComponentConsoleHelperHelper

Tags

None found

Methods

setHelperSet()

setHelperSet(\Symfony\Component\Console\Helper\HelperSet  $helperSet = null) 

Sets the helper set associated with this helper.

Parameters

SymfonyComponentConsoleHelperHelperSet $helperSet

A HelperSet instance

Inherited from
SymfonyComponentConsoleHelperHelper

Tags

None found

getHelperSet()

getHelperSet() : \Symfony\Component\Console\Helper\HelperSet

Gets the helper set associated with this helper.

Returns

SymfonyComponentConsoleHelperHelperSet

A HelperSet instance

Inherited from
SymfonyComponentConsoleHelperHelper

Tags

None found

formatSection()

formatSection(string  $section, string  $message, string  $style = 'info') 

Formats a message within a section.

Parameters

string $section

The section name

string $message

The message

string $style

The style to apply to the section

Tags

None found

formatBlock()

formatBlock(string|array  $messages, string  $style, Boolean  $large = false) : string

Formats a message as a block of text.

Parameters

string|array $messages

The message to write in the block

string $style

The style to apply to the whole block

Boolean $large

Whether to return a large block

Returns

string —

The formatter message

Tags

None found

getName()

getName() : string

Returns the helper's canonical name.

Returns

string —

The canonical name of the helper

Tags

None found

strlen()

strlen(string  $string) : integer

Returns the length of a string, using mb_strlen if it is available.

Parameters

string $string

The string to check its length

Returns

integer —

The length of the string

Tags

None found