PDOTask

Extends \Task

Handles PDO configuration needed by SQL type tasks.

Use {@link Project#createTask} to register a new Task.

author	Hans Lellelid hans@xmpl.org (Phing)
author	Nick Chalko nick@chalko.com (Ant)
author	Jeff Martin jeff@custommonkey.org (Ant)
author	Michael McCallum gholam@xtra.co.nz (Ant)
author	Tim Stephenson tim.stephenson@sybase.com (Ant)
version	$Id: fc34371090845b0038a74126bc21e7a1b5d7615c $
package	phing.tasks.system

Methods

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

Caching loaders / driver. This is to avoid getting an OutOfMemoryError when calling this task multiple times in a row; default: true

setCaching(mixed $enable)

Arguments

$enable

mixed

Sets the database connection URL; required.

setUrl($url)

Arguments

$url

Sets the password; required.

setPassword($password)

Arguments

$password

Auto commit flag for database connection; optional, default false.

setAutocommit($autocommit)

Arguments

$autocommit

Sets the version string, execute task only if rdbms version match; optional.

setVersion($version)

Arguments

$version

getLoaderMap

getLoaderMap()

Creates a new Connection as using the driver, url, userid and password specified.

getConnection() : \Connection

The calling method is responsible for closing the connection.

throws	if the UserId/Password/Url is not set or there is no suitable driver or the driver fails to load.

Response

\Connection

the newly created connection.

isCaching

isCaching($value)

Arguments

$value

Gets the autocommit.

isAutocommit() : \Returns

Response

\Returns

a boolean

Gets the url.

getUrl() : \Returns

Response

\Returns

a String

Gets the userId.

getUserId() : \Returns

Response

\Returns

a String

Set the user name for the connection; required.

setUserid($userId)

Arguments

$userId

Gets the password.

getPassword() : \Returns

Response

\Returns

a String

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 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.

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

Properties

caching

caching :

Autocommit flag. Default value is false

autocommit :

DB url.

url :

User name.

userId :

Password

password :

RDBMS Product needed for this SQL.

rdbms :

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