tasks/system/AdhocTaskdefTask.php

Show: inherited
Table of Contents

A class for creating adhoc tasks in build file.

<![CDATA[

       class FooTest extends Task {
           private $bar;

           function setBar($bar) {
               $this->bar = $bar;
           }

           function main() {
               $this->log("In FooTest: " . $this->bar);
           }
       }

   ]]></adhoc-task>

 <foo bar="B.L.I.N.G"/>

Author
Hans Lellelid  
Package
phing.tasks.system  
Version
$Id$  

\AdhocTaskdefTask

Package: phing\tasks\system

A class for creating adhoc tasks in build file.

<![CDATA[

       class FooTest extends Task {
           private $bar;

           function setBar($bar) {
               $this->bar = $bar;
           }

           function main() {
               $this->log("In FooTest: " . $this->bar);
           }
       }

   ]]></adhoc-task>

 <foo bar="B.L.I.N.G"/>

Parent(s)
\AdhocTask < \Task < \ProjectComponent
Author
Hans Lellelid  
Copyright
2001,2002 THYRELL. All rights reserved  
Version
$Id$  

Properties

Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\AdhocTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\AdhocTask::$$description  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\AdhocTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\AdhocTask::$$location  
Propertyprivate  $name= ''

The tag that refers to this task.

Details
Type
n/a
Propertyprotected  $newClasses= 'array()'
inheritedInherited from: \AdhocTask::$$newClasses
Default valuearray()Details
Type
n/a
Inherited_from
\AdhocTask::$$newClasses  
Propertyprotected\Project  $project= 'null'
inherited

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::$$project\Task::$$project\AdhocTask::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Inherited_from
\AdhocTask::$$project  
Propertyprotectedstring  $script= ''
inherited

The PHP script

Inherited from: \AdhocTask::$$script
Details
Type
string
Inherited_from
\AdhocTask::$$script  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\AdhocTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\AdhocTask::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName\AdhocTask::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Inherited_from
\AdhocTask::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType\AdhocTask::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Inherited_from
\AdhocTask::$$taskType  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper\AdhocTask::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Inherited_from
\AdhocTask::$$wrapper  

Methods

methodpublicaddText( string $script ) : void
inherited

Set the script.

Inherited from: \AdhocTask::addText()
Parameters
Name Type Description
$script string
methodprotectedexecute( ) : string
inherited

Load the adhoc class, and perform any core validation.

Inherited from: \AdhocTask::execute()
Returns
Type Description
string The classname of the ProjectComponent class.
Throws
Exception Description
\BuildException - if more than one class is defined.
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\AdhocTask::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

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

Inherited from: \Task::getLocation()\AdhocTask::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodprotectedgetNewClasses( ) : array
inherited

Get array of names of newly defined classes.

Inherited from: \AdhocTask::getNewClasses()
Returns
Type Description
array
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()\AdhocTask::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()\AdhocTask::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\AdhocTask::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\AdhocTask::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()\AdhocTask::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

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

Inherited from: \Task::getTaskType()\AdhocTask::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicinit( ) : void
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()\AdhocTask::init()

Should throw a BuildException if something goes wrong with the build

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

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\AdhocTask::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void

Main entry point

Should throw a BuildException if someting goes wrong with the build

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

methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()\AdhocTask::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()\AdhocTask::perform()
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()\AdhocTask::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetLocation( \Location $location ) : void
inherited

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

Inherited from: \Task::setLocation()\AdhocTask::setLocation()
Parameters
Name Type Description
$location \Location

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

methodpublicsetName( string $name ) : void

Set the tag that will represent this adhoc task/type.

Parameters
Name Type Description
$name string
methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()\AdhocTask::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()\AdhocTask::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()\AdhocTask::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\AdhocTask::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

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

Inherited from: \Task::setTaskType()\AdhocTask::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

Documentation was generated by DocBlox 0.18.1.