PDOTask

Extends \Task

Handles PDO configuration needed by SQL type tasks.

Use \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: ff221a5d49c565473f836701865b39a315acddb9 $

package

phing.tasks.system

Methods

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.

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

getLoaderMap

getLoaderMap() : mixed

Response

mixed

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.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Gets the password.

getPassword() : string

Response

string

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

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)

Gets the url.

getUrl() : string

Response

string

Gets the userId.

getUserId() : string

Response

string

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

Gets the autocommit.

isAutocommit() : \Returns

Response

\Returns

a boolean

isCaching

isCaching( $value) 

Arguments

$value

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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.

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

maybeConfigure() 
inherited

Perfrom this task

perform() 
inherited
throws

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

setCaching( $enable) 

Arguments

$enable

Sets a textual description of the task

setDescription(string $desc) 
inherited

Arguments

$desc

string

The text describing the task

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.

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

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

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

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

setTaskType( $name) 
inherited

Arguments

$name

Set the user name for the connection; required.

setUserid(string $userId) 

Arguments

$userId

string

Properties

caching

caching : 

Type(s)

Autocommit flag. Default value is false

autocommit : 

Type(s)

DB url.

url : 

Type(s)

User name.

userId : 

Type(s)

Password

password : 

Type(s)

RDBMS Product needed for this SQL.

rdbms : 

Type(s)

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