Handles Creole configuration needed by SQL type tasks.
Methods
Returns the textual description of the task
getDescription() : string
Inherited
inherited_from |
\Task::getDescription() |
Returns
string
The text description of the task
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
inherited_from |
\Task::getLocation() |
Returns
\Location
The location object describing the position of this
task within the buildfile.
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
inherited_from |
\Task::getOwningTarget() |
Returns
\Target
The target object that owns this task
Gets the password.
getPassword() : \Returns
Returns a reference to current project
getProject() : \Project
Inherited
inherited_from |
\ProjectComponent::getProject() |
inherited_from |
\Task::getProject() |
Returns
\Project
Reference to current porject object
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
inherited_from |
\Task::getTaskName() |
Returns
string
Name of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
inherited_from |
\Task::getTaskType() |
Returns
string
The type of this task (XML Tag)
Gets the url.
getUrl() : \Returns
Gets the userId.
getUserId() : \Returns
Initialize CreoleTask.
init()
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.
Exceptions
Gets the autocommit.
isAutocommit() : \Returns
Returns
\Returns
a boolean
isCaching()
isCaching($value)
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
string
The message to log
$level
integer
The priority of the message
Called by the project to let the task do it's work.
main()
Inherited
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.
inherited_from |
\Task::main() |
Auto commit flag for database connection;
optional, default false.
setAutocommit(\autocommit $autocommit)
Parameters
$autocommit
\autocommit
The autocommit to set
Caching loaders / driver.
setCaching($enable)
This is to avoid
getting an OutOfMemoryError when calling this task
multiple times in a row; default: true
Parameters
$enable
Sets a textual description of the task
setDescription(string $desc)
Inherited
inherited_from |
\Task::setDescription() |
Parameters
$desc
string
The text describing the task
Set the Creole driver to be used.
setDriver(string $driver)
Parameters
$driver
string
driver class name
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
inherited_from |
\Task::setLocation() |
Parameters
$location
\Location
The location object describing the position of this task within the buildfile.
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\Target
Reference to owning target
Sets the password; required.
setPassword(\password $password)
Parameters
$password
\password
The password to set
References the project to the current component.
setProject(\Project $project)
Inherited
inherited_from |
\ProjectComponent::setProject() |
inherited_from |
\Task::setProject() |
Parameters
$project
\Project
The reference to the current project
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
string
A string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
inherited_from |
\Task::setTaskType() |
Parameters
$name
string
The type of this task (XML Tag)
Sets the database connection URL; required.
setUrl(\url $url)
Set the user name for the connection; required.
setUserid(\userId $userId)
Parameters
$userId
\userId
The userId to set
Sets the version string, execute task only if
rdbms version match; optional.
setVersion(\version $version)
Parameters
$version
\version
The version to set
Creates a new Connection as using the driver, url, userid and password specified.
getConnection() : \Connection
The calling method is responsible for closing the connection.
Exceptions
\BuildException |
if the UserId/Password/Url is not set or there is no suitable driver or the driver fails to load. |
Returns
\Connection
the newly created connection.
getLoaderMap()
getLoaderMap()
Returns a name
getRegisterSlot(string $slotName)
Inherited
inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Properties
$description : string
Inherited
inherited_from |
\Task::$$description |
$location : \Location
Inherited
inherited_from |
\Task::$$location |
$project : \Project
Inherited
inherited_from |
\ProjectComponent::$$project |
inherited_from |
\Task::$$project |
$target : \Target
Inherited
inherited_from |
\Task::$$target |
$taskName : string
Inherited
inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
inherited_from |
\Task::$$taskType |
$loaderMap
This is to avoid
getting an OutOfMemoryError when calling this task
multiple times in a row.
NOT IMPLEMENTED YET