classes/phing/tasks/system/ExecTask.php
Classes
\ExecTask
Executes a command on the shell.
Use {@link Project#createTask} to register a new Task.
- Extends from
- \Task
- author
- Andreas Aderhold
- author
- Hans Lellelid
- author
- Christian Weiske
- copyright
- 2001,2002 THYRELL. All rights reserved
- package
- phing.tasks.system
- version
- $Revision: 1244 $
Properties
boolean
$checkreturn= 'false'
Whether to check the return code.
falseDetails- Type
- boolean
string
$command= ''
Command to execute.
- Type
- string
\Commandline
$commandline= ''
Commandline managing object
- Type
- \Commandline
\PhingFile
$dir= ''
Working directory.
- Type
- \PhingFile
\File
$error= ''
Where to direct error output.
- Type
- \File
boolean
$escape= 'false'
Whether to escape shell command using escapeshellcmd().
falseDetails- Type
- boolean
integer
$logLevel= 'Project'
Logging level for status messages
ProjectDetails- Type
- integer
boolean
$logOutput= 'false'
Whether to log returned output as MSG_INFO instead of MSG_VERBOSE
falseDetails- Type
- boolean
string
$os= ''
Operating system.
- Type
- string
\File
$output= ''
Where to direct output.
- Type
- \File
string
$outputProperty= ''
Property name to set with output value from exec call.
- Type
- string
boolean
$passthru= 'false'
Whether to use PHP's passthru() function instead of exec()
falseDetails- Type
- boolean
string
$returnProperty= ''
Property name to set with return value from exec call.
- Type
- string
boolean
$spawn= 'false'
If spawn is set then [unix] programs will redirect stdout and add '&'.
falseDetails- Type
- boolean
Methods
__construct(
)
:
buildCommand(
)
:
voidBuilds the full command to execute and stores it in $command.
- uses
- \$command
cleanup(
integer $return, array $output
)
:
voidRuns all tasks after command execution:
- change working directory back
- log output
- verify return value
| Name | Type | Description |
|---|---|---|
| $return | integer | Return code |
| $output | array | Array with command output |
createArg(
)
:
\CommandlineArgumentCreates a nested tag.
| Type | Description |
|---|---|
| \CommandlineArgument |
executeCommand(
)
:
arrayExecutes the command and returns return code and output.
| Type | Description |
|---|---|
| array |
isApplicable(
)
:
booleanChecks whether the command shall be executed
| Type | Description |
|---|---|
| boolean |
main(
)
:
voidMain method: wraps execute() command.
prepare(
)
:
voidPrepares the command building and execution, i.e.
changes to the specified directory.
setCheckreturn(
boolean $checkreturn
)
:
voidWhether to check the return code.
| Name | Type | Description |
|---|---|---|
| $checkreturn | boolean | If the return code shall be checked |
setCommand(
mixed $command
)
:
voidThe command to use.
| Name | Type | Description |
|---|---|---|
| $command | mixed | String or string-compatible (e.g. w/ __toString()). |
setDir(
\PhingFile $dir
)
:
voidSpecify the working directory for executing this command.
| Name | Type | Description |
|---|---|---|
| $dir | \PhingFile | Working directory |
setError(
\PhingFile $f
)
:
voidFile to which error output should be written.
| Name | Type | Description |
|---|---|---|
| $f | \PhingFile | Error log file |
setEscape(
boolean $escape
)
:
voidWhether to use escapeshellcmd() to escape command.
| Name | Type | Description |
|---|---|---|
| $escape | boolean | If the command shall be escaped or not |
setExecutable(
mixed $executable
)
:
voidThe executable to use.
| Name | Type | Description |
|---|---|---|
| $executable | mixed | String or string-compatible (e.g. w/ __toString()). |
setLevel(
string $level
)
:
voidSet level of log messages generated (default = verbose)
| Name | Type | Description |
|---|---|---|
| $level | string | Log level |
setLogoutput(
boolean $logOutput
)
:
voidWhether to log returned output as MSG_INFO instead of MSG_VERBOSE
| Name | Type | Description |
|---|---|---|
| $logOutput | boolean | If output shall be logged visibly |
setOs(
string $os
)
:
voidSpecify OS (or muliple OS) that must match in order to execute this command.
| Name | Type | Description |
|---|---|---|
| $os | string | Operating system string (e.g. "Linux") |
setOutput(
\PhingFile $f
)
:
voidFile to which output should be written.
| Name | Type | Description |
|---|---|---|
| $f | \PhingFile | Output log file |
setOutputProperty(
string $prop
)
:
voidThe name of property to set to output value from exec() call.
| Name | Type | Description |
|---|---|---|
| $prop | string | Property name |
setPassthru(
boolean $passthru
)
:
voidWhether to use PHP's passthru() function instead of exec()
| Name | Type | Description |
|---|---|---|
| $passthru | boolean | If passthru shall be used |
setReturnProperty(
string $prop
)
:
voidThe name of property to set to return value from exec() call.
| Name | Type | Description |
|---|---|---|
| $prop | string | Property name |
setSpawn(
boolean $spawn
)
:
voidWhether to suppress all output and run in the background.
| Name | Type | Description |
|---|---|---|
| $spawn | boolean | If the command is to be run in the background |