Phing API Documentation

author	Andreas Aderhold andi@binarycloud.com
author	Hans Lellelid hans@xmpl.org
author	Christian Weiske cweiske@cweiske.de
version	$Id: f519e4e90fdc87bd40ee563645b5def3e3ff0c0a $
package	phing.tasks.system

__construct

__construct()

Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.

main()

inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Checks whether the command shall be executed

isApplicable() : boolean

Response

boolean

False if the exec command shall not be run

Prepares the command building and execution, i.e.

prepare() : void

changes to the specified directory.

Builds the full command to execute and stores it in $command.

buildCommand() : void

uses

Executes the command and returns return code and output.

executeCommand() : array

Response

array

array(return code, array with output)

Runs all tasks after command execution: - change working directory back - log output - verify return value

cleanup(integer $return, array $output) : void

Arguments

$return

integer

Return code

$output

array

Array with command output

The command to use.

setCommand(mixed $command) : void

Arguments

$command

mixed

String or string-compatible (e.g. w/ __toString()).

The executable to use.

setExecutable(mixed $executable) : void

Arguments

$executable

mixed

String or string-compatible (e.g. w/ __toString()).

Whether to use escapeshellcmd() to escape command.

setEscape(boolean $escape) : void

Arguments

$escape

boolean

If the command shall be escaped or not

Specify the working directory for executing this command.

setDir(\PhingFile $dir) : void

Arguments

$dir

\PhingFile

Working directory

Specify OS (or muliple OS) that must match in order to execute this command.

setOs(string $os) : void

Arguments

$os

string

Operating system string (e.g. "Linux")

File to which output should be written.

setOutput(\PhingFile $f) : void

Arguments

$f

\PhingFile

Output log file

File to which error output should be written.

setError(\PhingFile $f) : void

Arguments

$f

\PhingFile

Error log file

Whether to use PHP's passthru() function instead of exec()

setPassthru(boolean $passthru) : void

Arguments

$passthru

boolean

If passthru shall be used

Whether to log returned output as MSG_INFO instead of MSG_VERBOSE

setLogoutput(boolean $logOutput) : void

Arguments

$logOutput

boolean

If output shall be logged visibly

Whether to suppress all output and run in the background.

setSpawn(boolean $spawn) : void

Arguments

$spawn

boolean

If the command is to be run in the background

Whether to check the return code.

setCheckreturn(boolean $checkreturn) : void

Arguments

$checkreturn

boolean

If the return code shall be checked

The name of property to set to return value from exec() call.

setReturnProperty(string $prop) : void

Arguments

$prop

string

Property name

The name of property to set to output value from exec() call.

setOutputProperty(string $prop) : void

Arguments

$prop

string

Property name

Set level of log messages generated (default = verbose)

setLevel(string $level) : void

Arguments

$level

string

Log level

Creates a nested <arg> tag.

createArg() : \CommandlineArgument

Response

\CommandlineArgument

Argument object

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)

inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target

inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string

inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string

inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string

inherited

Response

string

The type of this task (XML Tag)

Sets the type of the task. Usually this is the name of the XML tag

setTaskType($name)

inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)

inherited

Arguments

$slotName

string

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO)

inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)

inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string

inherited

Response

string

The text description of the task

Called by the parser to let the task initialize properly.

init()

inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location

inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location)

inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable

inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)

inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()

inherited

Perfrom this task

perform()

inherited

References the project to the current component.

setProject(\Project $project)

inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project

inherited

Response

\Project

Reference to current porject object

Command to be executed

realCommand : string

var

Type(s)

string

Given command

command : string

var

Type(s)

string

Commandline managing object

commandline : \Commandline

var

Type(s)

\Commandline

Working directory.

dir : \PhingFile

var

Type(s)

\PhingFile

Operating system.

os : string

var

Type(s)

string

Whether to escape shell command using escapeshellcmd().

escape : boolean

var

Type(s)

boolean

Where to direct output.

output : \File

var

Type(s)

\File

Whether to use PHP's passthru() function instead of exec()

passthru : boolean

var

Type(s)

boolean

Whether to log returned output as MSG_INFO instead of MSG_VERBOSE

logOutput : boolean

var

Type(s)

boolean

Logging level for status messages

logLevel : integer

var

Type(s)

integer

Where to direct error output.

error : \File

var

Type(s)

\File

If spawn is set then [unix] programs will redirect stdout and add '&'.

spawn : boolean

var

Type(s)

boolean

Property name to set with return value from exec call.

returnProperty : string

var

Type(s)

string

Property name to set with output value from exec call.

outputProperty : string

var

Type(s)

string

Whether to check the return code.

checkreturn : boolean

var

Type(s)

boolean

Owning Target object

target : \Target

inherited

var

Type(s)

\Target

Description of the task

description : string

inherited

var

Type(s)

string

Internal taskname (req)

taskType : string

inherited

var

Type(s)

string

Taskname for logger

taskName : string

inherited

var

Type(s)

string

Stored buildfile location

location : \Location

inherited

var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable

inherited

var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project

inherited

var	A reference to the current project instance

Type(s)

\Project

ExecTask

Methods

__construct

Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.

Checks whether the command shall be executed

Response

Prepares the command building and execution, i.e.

Builds the full command to execute and stores it in $command.

Executes the command and returns return code and output.

Response

Runs all tasks after command execution: - change working directory back - log output - verify return value

Arguments

$return

$output

The command to use.

Arguments

$command

The executable to use.

Arguments

$executable

Whether to use escapeshellcmd() to escape command.

Arguments

$escape

Specify the working directory for executing this command.

Arguments

$dir

Specify OS (or muliple OS) that must match in order to execute this command.

Arguments

$os

File to which output should be written.

Arguments

$f

File to which error output should be written.

Arguments

$f

Whether to use PHP's passthru() function instead of exec()

Arguments

$passthru

Whether to log returned output as MSG_INFO instead of MSG_VERBOSE

Arguments

$logOutput

Whether to suppress all output and run in the background.

Arguments

$spawn

Whether to check the return code.

Arguments

$checkreturn

The name of property to set to return value from exec() call.

Arguments

$prop

The name of property to set to output value from exec() call.

Arguments

$prop

Set level of log messages generated (default = verbose)

Arguments

$level

Creates a nested <arg> tag.

Response

Sets the owning target this task belongs to.

Arguments

$target

Returns the owning target of this task.

Response

Returns the name of task, used only for log messages

Response

Sets the name of this task for log messages

Arguments

$name

Response

Returns the name of the task under which it was invoked, usually the XML tagname

Response

Sets the type of the task. Usually this is the name of the XML tag

Arguments

$name

Returns a name

Arguments

$slotName

Logs a message with the given priority.

Arguments

$msg