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.
<
p>
<someelement>
The element
<acommandline executable="/executable/to/run">
<argument value="argument 1" />
<argument line="argument_1 argument_2 argument_3" />
<argument value="argument 4" />
</acommandline>
</someelement>
someelement
must provide a method
createAcommandline
which returns an instance of this class.
author |
thomas.haas@softwired-inc.com |
---|---|
author | |
package |
phing.types |
__construct($to_process = null)
createArgument(boolean $insertAtStart = false) : \CommandlineArgument
Each commandline object has at most one instance of the argument class.
boolean
if true, the argument is inserted at the beginning of the list of args, otherwise it is appended.
\CommandlineArgument
setExecutable($executable)
getExecutable()
addArguments($line)
getCommandline() : array
array
getArguments()
__toString()
quoteArgument($argument, $escape = false)
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.
exception |
BuildException if the argument contains both, single and double quotes. |
---|---|
toString($lines, $escape = false)
translateCommandline(string $to_process) : array
string
array
size() : int
int
Number of components in current commandline.
__copy()
clear()
clearArgs()
createMarker() : \CommandlineMarker
This marker can be used to locate a position on the commandline - to insert something for example - when all parameters have been set.
\CommandlineMarker
describeCommand(array $args = null) : string
This method assumes that the first entry in the array is the executable to run.
array
CommandlineArgument[] to use
string
describeArguments(mixed $args = null, mixed $offset) : string
mixed
arguments to use (default is to use current class args)
mixed
ignore entries before this index
string
DISCLAIMER
arguments : array
var |
CommandlineArguments[] |
---|
array
executable : string
var |
---|
string