Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • Command
  • Shell
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Command

Namespace: Symfony\Component\Finder\Shell
Author: Jean-François Simon <contact@jfsimon.fr>
Located at finder/Symfony/Component/Finder/Shell/Command.php
Methods summary
public
# __construct( Symfony\Component\Finder\Shell\Command $parent = null )

Constructor.

Constructor.

Parameters

$parent
Symfony\Component\Finder\Shell\Command
$parent Parent command
public string
# __toString( )

Returns command as string.

Returns command as string.

Returns

string
public static Symfony\Component\Finder\Shell\Command
# create( Symfony\Component\Finder\Shell\Command $parent = null )

Creates a new Command instance.

Creates a new Command instance.

Parameters

$parent
Symfony\Component\Finder\Shell\Command
$parent Parent command

Returns

Symfony\Component\Finder\Shell\Command
New Command instance
public static string
# escape( string $input )

Escapes special chars from input.

Escapes special chars from input.

Parameters

$input
string
$input A string to escape

Returns

string
The escaped string
public static string
# quote( string $input )

Quotes input.

Quotes input.

Parameters

$input
string
$input An argument string

Returns

string
The quoted string
public Symfony\Component\Finder\Shell\Command
# add( string|Symfony\Component\Finder\Shell\Command $bit )

Appends a string or a Command instance.

Appends a string or a Command instance.

Parameters

$bit
string|Symfony\Component\Finder\Shell\Command
$bit

Returns

Symfony\Component\Finder\Shell\Command
The current Command instance
public Symfony\Component\Finder\Shell\Command
# top( string|Symfony\Component\Finder\Shell\Command $bit )

Prepends a string or a command instance.

Prepends a string or a command instance.

Parameters

$bit
string|Symfony\Component\Finder\Shell\Command
$bit

Returns

Symfony\Component\Finder\Shell\Command
The current Command instance
public Symfony\Component\Finder\Shell\Command
# arg( string $arg )

Appends an argument, will be quoted.

Appends an argument, will be quoted.

Parameters

$arg
string
$arg

Returns

Symfony\Component\Finder\Shell\Command
The current Command instance
public Symfony\Component\Finder\Shell\Command
# cmd( string $esc )

Appends escaped special command chars.

Appends escaped special command chars.

Parameters

$esc
string
$esc

Returns

Symfony\Component\Finder\Shell\Command
The current Command instance
public Symfony\Component\Finder\Shell\Command
# ins( string $label )

Inserts a labeled command to feed later.

Inserts a labeled command to feed later.

Parameters

$label
string
$label The unique label

Returns

Symfony\Component\Finder\Shell\Command
The current Command instance

Throws

RuntimeException
If label already exists
public Symfony\Component\Finder\Shell\Command
# get( string $label )

Retrieves a previously labeled command.

Retrieves a previously labeled command.

Parameters

$label
string
$label

Returns

Symfony\Component\Finder\Shell\Command
The labeled command

Throws

RuntimeException
public Symfony\Component\Finder\Shell\Command
# end( )

Returns parent command (if any).

Returns parent command (if any).

Returns

Symfony\Component\Finder\Shell\Command
Parent command

Throws

RuntimeException
If command has no parent
public integer
# length( )

Counts bits stored in command.

Counts bits stored in command.

Returns

integer
The bits count
public array
# execute( )

Executes current command.

Executes current command.

Returns

array
The command result

Throws

RuntimeException
public string
# join( )

Joins bits.

Joins bits.

Returns

string
public Symfony\Component\Finder\Shell\Command
# addAtIndex( string|Symfony\Component\Finder\Shell\Command $bit, integer $index )

Insert a string or a Command instance before the bit at given position $index (index starts from 0).

Insert a string or a Command instance before the bit at given position $index (index starts from 0).

Parameters

$bit
string|Symfony\Component\Finder\Shell\Command
$bit
$index
integer
$index

Returns

Symfony\Component\Finder\Shell\Command
The current Command instance
php-coveralls API documentation generated by ApiGen 2.8.0