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)	from Helper
static	formatMemory($memory)	from Helper
static	strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)	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

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

Parameters

HelperSet

$helperSet

A HelperSet instance

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

Parameters

$secs

static formatMemory($memory)

Parameters

$memory

static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface	$formatter
	$string

__construct()

Constructor.

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