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

  • Application
  • CliOptionParser
  • Command
  • ConfigurationReader
  • Environment
  • InputDefinition
  • Version
  • Overview
  • Namespace
  • Class

Class Command

The default Peridot CLI command. Responsible for loading and executing tests.

Symfony\Component\Console\Command\Command
Extended by Peridot\Console\Command uses Peridot\Core\HasEventEmitterTrait
Namespace: Peridot\Console
Package: Peridot\Console
Located at Console/Command.php
Methods summary
public
# __construct( Peridot\Runner\RunnerInterface $runner, Peridot\Configuration $configuration, Peridot\Reporter\ReporterFactory $factory, Evenement\EventEmitterInterface $eventEmitter )

Parameters

$runner
$configuration
$factory
$eventEmitter

Throws

LogicException
When the command name is empty

Overrides

Symfony\Component\Console\Command\Command::__construct()
public
# setLoader( Peridot\Runner\SuiteLoaderInterface $loader )

Set the loader used by the Peridot command

Set the loader used by the Peridot command

Parameters

$loader

Returns


$this
public Peridot\Runner\SuiteLoaderInterface
# getLoader( )

Fetch the loader used by the Peridot command. Defaults to a glob based loader

Fetch the loader used by the Peridot command. Defaults to a glob based loader

Returns

Peridot\Runner\SuiteLoaderInterface
public
# setRunner( Peridot\Runner\RunnerInterface $runner )

Set the suite runner used by the Peridot command.

Set the suite runner used by the Peridot command.

Parameters

$runner

Returns


$this
public Peridot\Runner\RunnerInterface
# getRunner( )

Return the runner used by the Peridot command. Defaults to an instance of Peridot\Runner\Runner.

Return the runner used by the Peridot command. Defaults to an instance of Peridot\Runner\Runner.

Returns

Peridot\Runner\RunnerInterface
public string
# getSynopsis( boolean $short = false )

Returns the synopsis for the command.

Returns the synopsis for the command.

Parameters

$short
Whether to show the short version of the synopsis (with options folded) or not

Returns

string

Overrides

Symfony\Component\Console\Command\Command::getSynopsis()
protected integer
# execute( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output )

Load and run Suites and Tests

Load and run Suites and Tests

Parameters

$input
$output

Returns

integer

Throws

LogicException
When this abstract method is not implemented

Overrides

Symfony\Component\Console\Command\Command::execute()
protected
# listReporters( Symfony\Component\Console\Output\OutputInterface $output )

Output available reporters

Output available reporters

Parameters

$output
protected integer
# getResult( )

Return the result as an integer.

Return the result as an integer.

Returns

integer
Methods inherited from Symfony\Component\Console\Command\Command
addArgument(), addOption(), addUsage(), asText(), asXml(), configure(), getAliases(), getApplication(), getDefinition(), getDescription(), getHelp(), getHelper(), getHelperSet(), getName(), getNativeDefinition(), getProcessedHelp(), getUsages(), ignoreValidationErrors(), initialize(), interact(), isEnabled(), mergeApplicationDefinition(), run(), setAliases(), setApplication(), setCode(), setDefinition(), setDescription(), setHelp(), setHelperSet(), setName(), setProcessTitle()
Methods used from Peridot\Core\HasEventEmitterTrait
getEventEmitter(), setEventEmitter()
Properties summary
protected Peridot\Runner\RunnerInterface $runner
#
protected Peridot\Configuration $configuration
#
protected Peridot\Reporter\ReporterFactory $factory
#
protected Peridot\Runner\SuiteLoaderInterface $loader
#
Properties used from Peridot\Core\HasEventEmitterTrait
$eventEmitter
Peridot API documentation generated by ApiGen