1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Console
  7. \
  8. Helper
  9. \
  10. DescriptorHelper

DescriptorHelper

class DescriptorHelper extends Helper

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

Properties

protected $helperSet from Helper

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 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

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

Parameters

HelperSet $helperSet

HelperSet getHelperSet()

Gets the helper set associated with this helper.

Return Value

HelperSet A HelperSet instance

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

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

static formatTime($secs)

Parameters

$secs

static formatMemory($memory)

Parameters

$memory

static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

static removeDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

__construct()

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

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

Registers a descriptor.

Parameters

string $format
DescriptorInterface $descriptor

Return Value

$this

string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name