class DescriptorHelper extends DescriptorHelper

Properties

protected $helperSet from Helper

Methods

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

from Helper
getHelperSet()

Gets the helper set associated with this helper.

from Helper
static int
strlen(string $string)

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

from Helper
static string
substr(string $string, int $from, int|null $length = null)

Returns the subset of a string, using mb_substr if it is available.

from Helper
static 
formatTime($secs)

No description

from Helper
static 
formatMemory($memory)

No description

from Helper
static 
strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

No description

from Helper
static 
removeDecoration(OutputFormatterInterface $formatter, $string)

No description

from Helper
__construct()

No description

describe(OutputInterface $output, object $object, array $options = array())

Describes an object if supported.

$this
register(string $format, DescriptorInterface $descriptor)

Registers a descriptor.

string
getName()

Returns the canonical name of this helper.

Details

in Helper at line 28
setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

Parameters

HelperSet $helperSet

in Helper at line 36
HelperSet getHelperSet()

Gets the helper set associated with this helper.

Return Value

HelperSet A HelperSet instance

in Helper at line 48
static int strlen(string $string)

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

Parameters

string $string The string to check its length

Return Value

int The length of the string

in Helper at line 66
static string substr(string $string, int $from, int|null $length = null)

Returns the subset of a string, using mb_substr if it is available.

Parameters

string $string String to subset
int $from Start offset
int|null $length Length to read

Return Value

string The string subset

in Helper at line 75
static formatTime($secs)

Parameters

$secs

in Helper at line 104
static formatMemory($memory)

Parameters

$memory

in Helper at line 121
static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

in Helper at line 126
static removeDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

at line 25
__construct()

in DescriptorHelper at line 57
describe(OutputInterface $output, object $object, array $options = array())

Describes an object if supported.

Available options are: * format: string, the output format name * raw_text: boolean, sets output type as raw

Parameters

OutputInterface $output
object $object
array $options

Exceptions

InvalidArgumentException when the given format is not supported

in DescriptorHelper at line 80
$this register(string $format, DescriptorInterface $descriptor)

Registers a descriptor.

Parameters

string $format
DescriptorInterface $descriptor

Return Value

$this

in DescriptorHelper at line 90
string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name