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
  • ConsoleEvents
  • Shell
  • Overview
  • Namespace
  • Class

Class Shell

A Shell wraps an Application to add shell capabilities to it.

Support for history and completion only works with a PHP compiled with readline support (either --with-readline or --with-libedit)

Namespace: Symfony\Component\Console
Deprecated: since version 2.8, to be removed in 3.0.
Author: Fabien Potencier fabien@symfony.com
Author: Martin HasoĊˆ martin.hason@gmail.com
Located at Shell.php
Methods summary
public
# __construct( Symfony\Component\Console\Application $application )

Constructor.

Constructor.

If there is no readline support for the current PHP executable a \RuntimeException exception is thrown.

Parameters

$application
An application instance
public
# run( )

Runs the shell.

Runs the shell.

protected string
# getHeader( )

Returns the shell header.

Returns the shell header.

Returns

string
The header string
protected string
# getPrompt( )

Renders a prompt.

Renders a prompt.

Returns

string
The prompt
protected
# getOutput( )
protected
# getApplication( )
public
# getProcessIsolation( )
public
# setProcessIsolation( $processIsolation )
Peridot API documentation generated by ApiGen