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>
<acommandline executable="/executable/to/run">
<argument value="argument 1" />
<argument line="argument_1 argument_2 argument_3" />
<argument value="argument 4" />
</acommandline>
</someelement>
The element
someelement
must provide a method
createAcommandline
which returns an instance of this class.
| author | thomas.haas@softwired-inc.com |
|---|---|
| author | <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a> |
| package | phing.types |
__construct($to_process)
__copy()
__toString()
addArguments($line)
clear()
clearArgs()
createArgument(boolean $insertAtStart) : \CommandlineArgument
Each commandline object has at most one instance of the argument class.
booleanif true, the argument is inserted at the beginning of the list of args, otherwise it is appended.
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.
describeCommand(array $args) : string
This method assumes that the first entry in the array is the executable to run.
arrayCommandlineArgument[] to use
stringgetArguments()
getCommandline() : array
arraygetExecutable()
quoteArgument($argument, $escape)
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. |
|---|
setExecutable($executable)
size() : int
intNumber of components in current commandline.toString($lines, $escape)
translateCommandline(string $to_process) : array
string
arraydescribeArguments($args, $offset) : string
arguments to use (default is to use current class args)
ignore entries before this index
string$arguments : array
$executable : string
DISCLAIMER