Task.php
The base class for all Tasks.
Use {@link Project#createTask} to register a new Task.
- Author
- Andreas Aderhold
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Package
- phing
- See
- \Project#createTask()
- Version
- $Id$
\Task
The base class for all Tasks.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \ProjectComponent
- Children
- \ApiGenTask
- \CreoleTask
- \GitBaseTask
- \PhpDocumentor2Task
- \PhpDocumentorTask
- \HttpRequestTask
- \Service_Amazon
- \SshTask
- \PatchTask
- \JslLintTask
- \PackageAsPathTask
- \ZendCodeAnalyzerTask
- \PhkPackageTask
- \PHPMDTask
- \PhpDependTask
- \CapsuleTask
- \FileSizeTask
- \CoverageReportTask
- \CoverageSetupTask
- \CoverageThresholdTask
- \CoverageMergerTask
- \ZendGuardLicenseTask
- \PhpCodeSnifferTask
- \XmlLintTask
- \JsMinTask
- \PHPCPDTask
- \ScpTask
- \PhpLintTask
- \SimpleTestTask
- \DbDeployTask
- \PDOTask
- \DocBloxTask
- \SymfonyConsoleTask
- \AbstractLiquibaseTask
- \rSTTask
- \SmartyTask
- \FtpDeployTask
- \ReplaceRegexpTask
- \ManifestTask
- \SymlinkTask
- \MailTask
- \IoncubeLicenseTask
- \IoncubeEncoderTask
- \ExportPropertiesTask
- \SvnBaseTask
- \PHPUnitTask
- \PHPUnitReportTask
- \VersionTask
- \FileHashTask
- \HttpGetTask
- \TryCatchTask
- \TouchTask
- \AvailableTask
- \CVSPassTask
- \IncludePathTask
- \LoadFileTask
- \MkdirTask
- \TypedefTask
- \ExecTask
- \CvsTask
- \SequentialTask
- \AppendTask
- \ReflexiveTask
- \MatchingTask
- \FailTask
- \TstampTask
- \PropertyTask
- \ResolvePathTask
- \InputTask
- \DeleteTask
- \ChmodTask
- \AdhocTask
- \PhingTask
- \ForeachTask
- \TaskdefTask
- \PropertyPromptTask
- \CopyTask
- \UpToDateTask
- \PhpEvalTask
- \ImportTask
- \EchoTask
- \PhingCallTask
- \ChownTask
- \TaskAdapter
- \UnknownElement
- See
- \Project#createTask()
- Author
- Andreas Aderhold
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id$
Properties


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
Methods


getDescription(
)
:
string
Returns the textual description of the task
Type | Description |
---|---|
string | The text description of the task |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getOwningTarget(
)
:
\Target
Returns the owning target of this task.
Type | Description |
---|---|
\Target | The target object that owns this task |


getRegisterSlot(
string $slotName
)
:
void
Returns a name
Name | Type | Description |
---|---|---|
$slotName | string |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskName(
)
:
string
Returns the name of task, used only for log messages
Type | Description |
---|---|
string | Name of this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Called by the parser to let the task initialize properly.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Provides a project level log event to the task.
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
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 phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


setDescription(
string $desc
)
:
void
Sets a textual description of the task
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Sets the owning target this task belongs to.
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Sets the name of this task for log messages
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |