Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • DebugFormatterHelper
  • DescriptorHelper
  • DialogHelper
  • FormatterHelper
  • Helper
  • HelperSet
  • InputAwareHelper
  • ProcessHelper
  • ProgressBar
  • ProgressHelper
  • ProgressIndicator
  • QuestionHelper
  • SymfonyQuestionHelper
  • Table
  • TableCell
  • TableHelper
  • TableSeparator
  • TableStyle

Interfaces

  • HelperInterface
  • Overview
  • Namespace
  • Class

Class DescriptorHelper

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

Symfony\Component\Console\Helper\Helper implements Symfony\Component\Console\Helper\HelperInterface
Extended by Symfony\Component\Console\Helper\DescriptorHelper
Namespace: Symfony\Component\Console\Helper
Author: Jean-François Simon contact@jfsimon.fr
Located at Helper/DescriptorHelper.php
Methods summary
public
# __construct( )

Constructor.

Constructor.

public
# describe( Symfony\Component\Console\Output\OutputInterface $output, object $object, array $options = array() )

Describes an object if supported.

Describes an object if supported.

Available options are: * format: string, the output format name * raw_text: boolean, sets output type as raw

Parameters

$output
$object
$options

Throws

Symfony\Component\Console\Exception\InvalidArgumentException
when the given format is not supported
public Symfony\Component\Console\Helper\DescriptorHelper
# register( string $format, Symfony\Component\Console\Descriptor\DescriptorInterface $descriptor )

Registers a descriptor.

Registers a descriptor.

Parameters

$format
$descriptor

Returns

Symfony\Component\Console\Helper\DescriptorHelper
public string
# getName( )

Returns the canonical name of this helper.

Returns the canonical name of this helper.

Returns

string
The canonical name
Methods inherited from Symfony\Component\Console\Helper\Helper
formatMemory(), formatTime(), getHelperSet(), setHelperSet(), strlen(), strlenWithoutDecoration()
Properties inherited from Symfony\Component\Console\Helper\Helper
$helperSet
Peridot API documentation generated by ApiGen