TYPO3  7.6
Public Member Functions | Private Attributes | List of all members
DescriptorHelper Class Reference
Inheritance diagram for DescriptorHelper:
Helper HelperInterface

Public Member Functions

 __construct ()
 
 describe (OutputInterface $output, $object, array $options=array())
 
 register ($format, DescriptorInterface $descriptor)
 
 getName ()
 
- Public Member Functions inherited from Helper
 setHelperSet (HelperSet $helperSet=null)
 
 getHelperSet ()
 

Private Attributes

 $descriptors = array()
 

Additional Inherited Members

- Static Public Member Functions inherited from Helper
static strlen ($string)
 
static formatTime ($secs)
 
static formatMemory ($memory)
 
static strlenWithoutDecoration (OutputFormatterInterface $formatter, $string)
 
- Protected Attributes inherited from Helper
 $helperSet = null
 

Detailed Description

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

Author
Jean-François Simon conta.nosp@m.ct@j.nosp@m.fsimo.nosp@m.n.fr

Definition at line 26 of file DescriptorHelper.php.

Constructor & Destructor Documentation

__construct ( )

Constructor.

Definition at line 36 of file DescriptorHelper.php.

Member Function Documentation

describe ( OutputInterface  $output,
  $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
\InvalidArgumentExceptionwhen the given format is not supported

Definition at line 59 of file DescriptorHelper.php.

getName ( )

{Returns the canonical name of this helper.

Returns
string The canonical name
}

Implements HelperInterface.

Definition at line 92 of file DescriptorHelper.php.

register (   $format,
DescriptorInterface  $descriptor 
)

Registers a descriptor.

Parameters
string$format
DescriptorInterface$descriptor
Returns
DescriptorHelper

Definition at line 82 of file DescriptorHelper.php.

Member Data Documentation

$descriptors = array()
private

Definition at line 31 of file DescriptorHelper.php.