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 HelperSet

HelperSet represents a set of helpers to be used with a command.

Symfony\Component\Console\Helper\HelperSet implements IteratorAggregate
Namespace: Symfony\Component\Console\Helper
Author: Fabien Potencier fabien@symfony.com
Located at Helper/HelperSet.php
Methods summary
public
# __construct( array $helpers = array() )

Constructor.

Constructor.

Parameters

$helpers
An array of helper
public
# set( Symfony\Component\Console\Helper\HelperInterface $helper, string $alias = null )

Sets a helper.

Sets a helper.

Parameters

$helper
The helper instance
$alias
An alias
public boolean
# has( string $name )

Returns true if the helper if defined.

Returns true if the helper if defined.

Parameters

$name
The helper name

Returns

boolean
true if the helper is defined, false otherwise
public Symfony\Component\Console\Helper\HelperInterface
# get( string $name )

Gets a helper value.

Gets a helper value.

Parameters

$name
The helper name

Returns

Symfony\Component\Console\Helper\HelperInterface
The helper instance

Throws

Symfony\Component\Console\Exception\InvalidArgumentException
if the helper is not defined
public
# setCommand( Symfony\Component\Console\Command\Command $command = null )

Sets the command associated with this helper set.

Sets the command associated with this helper set.

Parameters

$command
A Command instance
public Symfony\Component\Console\Command\Command
# getCommand( )

Gets the command associated with this helper set.

Gets the command associated with this helper set.

Returns

Symfony\Component\Console\Command\Command
A Command instance
public Symfony\Component\Console\Helper\Helper[]
# getIterator( )

Returns

Symfony\Component\Console\Helper\Helper[]

Implementation of

IteratorAggregate::getIterator()
Peridot API documentation generated by ApiGen