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 Application

The main Peridot application class.

Symfony\Component\Console\Application
Extended by Peridot\Console\Application
Namespace: Peridot\Console
Package: Peridot\Console
Located at Console/Application.php
Methods summary
public
# __construct( Peridot\Console\Environment $environment )

Parameters

$environment

Overrides

Symfony\Component\Console\Application::__construct()
public integer
# run( Symfony\Component\Console\Input\InputInterface $input = null, Symfony\Component\Console\Output\OutputInterface $output = null )

Runs the current application.

Runs the current application.

Parameters

$input
$output

Returns

integer

Throws

Exception
When doRun returns Exception

Overrides

Symfony\Component\Console\Application::run()
public integer
# doRun( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output )

Run the Peridot application

Run the Peridot application

Parameters

$input
$output

Returns

integer

Overrides

Symfony\Component\Console\Application::doRun()
public Symfony\Component\Console\Input\ArgvInput
# getInput( array $argv = null )

Fetch the ArgvInput used by Peridot. If any exceptions are thrown due to a mismatch between the option or argument requested and the input definition, the exception will be rendered and Peridot will exit with an error code.

Fetch the ArgvInput used by Peridot. If any exceptions are thrown due to a mismatch between the option or argument requested and the input definition, the exception will be rendered and Peridot will exit with an error code.

Parameters

$argv
An array of parameters from the CLI in the argv format.

Returns

Symfony\Component\Console\Input\ArgvInput
public string
# getCommandName( Symfony\Component\Console\Input\InputInterface $input )

Return's peridot as the sole command used by Peridot

Return's peridot as the sole command used by Peridot

Parameters

$input

Returns

string

Overrides

Symfony\Component\Console\Application::getCommandName()
public
# loadDsl( $dslPath )

Load the configured DSL.

Load the configured DSL.

Parameters

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

Set the runner used by the Peridot application.

Set the runner used by the Peridot application.

Parameters

$runner

Returns


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

Get the RunnerInterface being used by the Peridot application. If one is not set, a default Runner will be used.

Get the RunnerInterface being used by the Peridot application. If one is not set, a default Runner will be used.

Returns

Peridot\Runner\RunnerInterface
public Peridot\Console\Environment
# getEnvironment( )

Return the Environment used by the Peridot application.

Return the Environment used by the Peridot application.

Returns

Peridot\Console\Environment
public Peridot\Configuration
# getConfiguration( )

Return the configuration used by the Peridot application.

Return the configuration used by the Peridot application.

Returns

Peridot\Configuration
public
# setConfiguration( Peridot\Configuration $configuration )

Set the configuration object used by the Peridot application.

Set the configuration object used by the Peridot application.

Parameters

$configuration

Returns


$this
protected Peridot\Console\InputDefinition
# getDefaultInputDefinition( )

Return the peridot input definition defined by Environment

Return the peridot input definition defined by Environment

Returns

Peridot\Console\InputDefinition

Overrides

Symfony\Component\Console\Application::getDefaultInputDefinition()
protected
# validateConfiguration( )

Validate that a supplied configuration exists.

Validate that a supplied configuration exists.

Methods inherited from Symfony\Component\Console\Application
add(), addCommands(), all(), asText(), asXml(), configureIO(), doRunCommand(), extractNamespace(), find(), findNamespace(), get(), getAbbreviations(), getDefaultCommands(), getDefaultHelperSet(), getDefinition(), getHelp(), getHelperSet(), getLongVersion(), getName(), getNamespaces(), getTerminalDimensions(), getTerminalHeight(), getTerminalWidth(), getVersion(), has(), register(), renderException(), setAutoExit(), setCatchExceptions(), setDefaultCommand(), setDefinition(), setDispatcher(), setHelperSet(), setName(), setTerminalDimensions(), setVersion()
Properties summary
protected Peridot\Console\Environment $environment
#
protected Peridot\Runner\RunnerInterface $runner
#
protected Peridot\Configuration $configuration
#
Peridot API documentation generated by ApiGen