Class Symfony\Component\Console\Helper\DescriptorHelper

InheritanceSymfony\Component\Console\Helper\DescriptorHelper » Symfony\Component\Console\Helper\Helper
ImplementsSymfony\Component\Console\Helper\HelperInterface

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

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$helperSet Symfony\Component\Console\Helper\Helper

Method Details

__construct() public method

Constructor.

public void __construct ( )
describe() public method

Describes an object if supported.

Available options are:

  • format: string, the output format name
  • raw_text: boolean, sets output type as raw
public void describe ( Symfony\Component\Console\Output\OutputInterface $output, $object, array $options = [] )
$output Symfony\Component\Console\Output\OutputInterface
$object object
$options array
throws Symfony\Component\Console\Exception\InvalidArgumentException

when the given format is not supported

getName() public method

{@inheritdoc}

public void getName ( )
register() public method

Registers a descriptor.

public Symfony\Component\Console\Helper\DescriptorHelper register ( $format, Symfony\Component\Console\Descriptor\DescriptorInterface $descriptor )
$format string
$descriptor Symfony\Component\Console\Descriptor\DescriptorInterface