1. class
  2. Symfony
  3. Component
  4. Console
  5. Helper
  6. DescriptorHelper

DescriptorHelper

class DescriptorHelper extends Helper

This class adds helper method to describe objects in various formats.

Methods

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

from Helper
HelperSet
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 
formatTime($secs)

No description

from Helper
static 
formatMemory($memory)

No description

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

No description

from Helper
__construct()

Constructor.

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

Describes an object if supported.

DescriptorHelper
register(string $format, DescriptorInterface $descriptor)

Registers a descriptor.

string
getName()

Returns the canonical name of this helper.

Details

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

Sets the helper set associated with this helper.

Parameters

HelperSet $helperSet A HelperSet instance

in Helper at line line 40
HelperSet getHelperSet()

Gets the helper set associated with this helper.

Return Value

HelperSet A HelperSet instance

in Helper at line line 52
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 line 61
static formatTime($secs)

Parameters

$secs

in Helper at line line 88
static formatMemory($memory)

Parameters

$memory

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

Parameters

OutputFormatterInterface $formatter
$string

at line line 37
__construct()

Constructor.

at line line 60
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

at line line 83
DescriptorHelper register(string $format, DescriptorInterface $descriptor)

Registers a descriptor.

Parameters

string $format
DescriptorInterface $descriptor

Return Value

DescriptorHelper

at line line 93
string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name