Symfony 1.0.0 : Vue détaillée de Commandline.php

(pas de description)

Poids:	467 lignes (14 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 3 classes

Commandline:: (18 méthodes):
  __construct()
  createArgument()
  setExecutable()
  getExecutable()
  addArguments()
  getCommandline()
  getArguments()
  __toString()
  quoteArgument()
  toString()
  translateCommandline()
  size()
  __copy()
  clear()
  clearArgs()
  createMarker()
  describeCommand()
  describeArguments()

CommandlineArgument:: (6 méthodes):
  __construct()
  setValue()
  setLine()
  setPath()
  setFile()
  getParts()

CommandlineMarker:: (2 méthodes):
__construct()
getPosition()

Classe: Commandline - X-Ref

Commandline objects help handling command lines specifying processes to
execute.

The class can be used to define a command line as nested elements or as a
helper to define a command line by an application.

<code>
<someelement> 
  <acommandline executable="/executable/to/run"> 
    <argument value="argument 1" /> 
    <argument line="argument_1 argument_2 argument_3" /> 
    <argument value="argument 4" /> 
  </acommandline> 
</someelement> 
</code>
The element <code>someelement</code> must provide a method
<code>createAcommandline</code> which returns an instance of this class.

__construct($to_process = null) X-Ref

Pas de description

createArgument($insertAtStart = false) X-Ref

Creates an argument object and adds it to our list of args.

Each commandline object has at most one instance of the
argument class.

param: boolean $insertAtStart if true, the argument is inserted at the
return: CommandlineArgument

setExecutable($executable) X-Ref

Sets the executable to run.

getExecutable() X-Ref

Pas de description

addArguments($line) X-Ref

Pas de description

getCommandline() X-Ref

Returns the executable and all defined arguments.

return: array

getArguments() X-Ref

Returns all arguments defined by <code>addLine</code>,
<code>addValue</code> or the argument object.

__toString() X-Ref

Pas de description

quoteArgument($argument) X-Ref

Put quotes around the given String if necessary.

If the argument doesn't include spaces or quotes, return it
as is. If it contains double quotes, use single quotes - else
surround the argument by double quotes.

toString($lines) X-Ref

Quotes the parts of the given array in way that makes them
usable as command line arguments.

translateCommandline($to_process) X-Ref

param: string $to_process
return: array

size() X-Ref

return: int Number of components in current commandline.

__copy() X-Ref

Pas de description

clear() X-Ref

Pas de description

clearArgs() X-Ref

Clear out the arguments but leave the executable in place for
another operation.

createMarker() X-Ref

Return a marker.

This marker can be used to locate a position on the
commandline - to insert something for example - when all
parameters have been set.
return: CommandlineMarker

describeCommand($args = null) X-Ref

Returns a String that describes the command and arguments
suitable for verbose output before a call to
<code>Runtime.exec(String[])<code>.

This method assumes that the first entry in the array is the
executable to run.
param: array $args CommandlineArgument[] to use
return: string

describeArguments($args = null, $offset = 0) X-Ref

Returns a String that describes the arguments suitable for
verbose output before a call to
<code>Runtime.exec(String[])<code>

param: $args arguments to use (default is to use current class args)
param: $offset ignore entries before this index
return: string

Classe: CommandlineArgument - X-Ref

"Inner" class used for nested xml command line definitions.

__construct(Commandline $outer) X-Ref

Pas de description

setValue($value) X-Ref

Sets a single commandline argument.

param: string $value a single commandline argument.

setLine($line) X-Ref

Line to split into several commandline arguments.

param: line line to split into several commandline arguments

setPath($value) X-Ref

Sets a single commandline argument and treats it like a
PATH - ensures the right separator for the local platform
is used.

param: value a single commandline argument.

setFile(PhingFile $value) X-Ref

Sets a single commandline argument to the absolute filename
of the given file.

param: value a single commandline argument.

getParts() X-Ref

Returns the parts this Argument consists of.

return: array string[]

Classe: CommandlineMarker - X-Ref

__construct(Comandline $outer, $position) X-Ref

Pas de description

getPosition() X-Ref

Return the number of arguments that preceeded this marker.

The name of the executable - if set - is counted as the
very first argument.

Code source de Symfony 1.0.0

/lib/vendor/phing/types/ -> Commandline.php (sommaire)

Définit 3 classes