tasks/ext/pdo/PDOTask.php

Show: inherited
Table of Contents

Handles PDO 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$  

\PDOTask

Package: phing\tasks\system

Handles PDO configuration needed by SQL type tasks.

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

Parent(s)
\Task < \ProjectComponent
Children
\PDOSQLExecTask
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

Propertyprivate  $autocommit= 'false'

Autocommit flag. Default value is false

Default valuefalseDetails
Type
n/a
Propertyprivate  $caching= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

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

Stored buildfile location

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

Password

Details
Type
n/a
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
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprivate  $rdbms= ''

RDBMS Product needed for this SQL.

Details
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

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

Taskname for logger

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

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprivate  $url= ''

DB url.

Details
Type
n/a
Propertyprivate  $userId= ''

User name.

Details
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

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

Methods

methodprotectedgetConnection( ) : \Connection

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

The calling method is responsible for closing the connection.

Returns
Type Description
\Connection the newly created connection.
Throws
Exception Description
\BuildException if the UserId/Password/Url is not set or there is no suitable driver or the driver fails to load.
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodprotectedgetLoaderMap( ) : void

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()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetPassword( ) : \Returns

Gets the password.

Returns
Type Description
\Returns a String
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

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

Returns a name

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

Returns the wrapper object for runtime configuration

Inherited from: \Task::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()
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()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicgetUrl( ) : \Returns

Gets the url.

Returns
Type Description
\Returns a String
methodpublicgetUserId( ) : \Returns

Gets the userId.

Returns
Type Description
\Returns a String
methodpublicinit( ) : 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.

Throws
Exception Description
\BuildException
methodpublicisAutocommit( ) : \Returns

Gets the autocommit.

Returns
Type Description
\Returns a boolean
methodpublicisCaching(  $value ) : void

Parameters
Name Type Description
$value
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::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
abstractinherited

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.

methodpublicmaybeConfigure( ) : void
inherited

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

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

Perfrom this task

Inherited from: \Task::perform()
methodpublicsetAutocommit( \autocommit $autocommit ) : void

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

Parameters
Name Type Description
$autocommit \autocommit

The autocommit to set

methodpublicsetCaching(  $enable ) : void

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

Parameters
Name Type Description
$enable
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::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()
Parameters
Name Type Description
$location \Location

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

methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

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

Reference to owning target

methodpublicsetPassword( \password $password ) : void

Sets the password; required.

Parameters
Name Type Description
$password \password

The password to set

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::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()
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()
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()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetUrl( \url $url ) : void

Sets the database connection URL; required.

Parameters
Name Type Description
$url \url

The url to set

methodpublicsetUserid( \userId $userId ) : void

Set the user name for the connection; required.

Parameters
Name Type Description
$userId \userId

The userId to set

methodpublicsetVersion( \version $version ) : void

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

Parameters
Name Type Description
$version \version

The version to set

Documentation was generated by DocBlox 0.18.1.