tasks/ext/creole/CreoleTask.php
Handles Creole configuration needed by SQL type tasks.
- Author
- Hans Lellelid
(Phing) - Author
- Nick Chalko
(Ant) - Author
- Jeff Martin
(Ant) - Author
- Michael McCallum
(Ant) - Author
- Tim Stephenson
(Ant) - Package
- phing.tasks.system
- Version
- $Id$
\CreoleTask
Handles Creole configuration needed by SQL type tasks.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Children
- \CreoleSQLExecTask
- Author
- Hans Lellelid
(Phing) - Author
- Nick Chalko
(Ant) - Author
- Jeff Martin
(Ant) - Author
- Michael McCallum
(Ant) - Author
- Tim Stephenson
(Ant) - Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id$
Properties


$loaderMap= 'array()'
Used for caching loaders / driver. This is to avoid getting an OutOfMemoryError when calling this task multiple times in a row.
NOT IMPLEMENTED YET
array()
Details- Type
- n/a


\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::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


getConnection(
)
:
\Connection
Creates a new Connection as using the driver, url, userid and password specified.
The calling method is responsible for closing the connection.
Type | Description |
---|---|
\Connection | the newly created connection. |
Exception | Description |
---|---|
\BuildException | if the UserId/Password/Url is not set or there is no suitable driver or the driver fails to load. |


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


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


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


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


init(
)
:
void
Initialize CreoleTask.
This method includes any necessary Creole libraries and triggers appropriate error if they cannot be found. This is not done in header because we may want this class to be loaded w/o triggering an error.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
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.
Inherited from: \Task::main()Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setAutocommit(
\autocommit $autocommit
)
:
void
Auto commit flag for database connection; optional, default false.
Name | Type | Description |
---|---|---|
$autocommit | \autocommit | The autocommit to set |


setCaching(
$enable
)
:
void
Caching loaders / driver. This is to avoid getting an OutOfMemoryError when calling this task multiple times in a row; default: true
Name | Type | Description |
---|---|---|
$enable |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setDriver(
string $driver
)
:
void
Set the Creole driver to be used.
Name | Type | Description |
---|---|---|
$driver | string | driver class name |


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


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPassword(
\password $password
)
:
void
Sets the password; required.
Name | Type | Description |
---|---|---|
$password | \password | The password to set |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::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.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


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


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setUrl(
\url $url
)
:
void
Sets the database connection URL; required.
Name | Type | Description |
---|---|---|
$url | \url | The url to set |


setUserid(
\userId $userId
)
:
void
Set the user name for the connection; required.
Name | Type | Description |
---|---|---|
$userId | \userId | The userId to set |