# tasks/ext/creole/CreoleTask.php

## \CreoleTask
jump to top

Package: phing\tasks\system

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
  $Revision: 526 $

### Properties

`$autocommit= 'false'`

Autocommit flag. Default value is false

Default value `false` Details

Type

`$caching= 'true'`
Default value `true` Details

Type

`string $description= ''`
inherited

description of the taskInherited from: \Task::$description
Details

Type
  string
Inherited_from
  \Task::$description

`$driver= ''`

[optional] Classpath to Creole driver to use.

Details

Type
$driver

  string

`$loaderMap= 'array()'`
static

Used for caching loaders / driver. This is to avoid getting an OutOfMemoryError when calling this task multiple times in a row.

NOT IMPLEMENTED YET

Default value `array()`Details

Type

`\Location $location= ''`
inherited

stored buildfile locationInherited from: \Task::$location
Details

Type
  \Location
Inherited_from
  \Task::$location

`$password= ''`

Password

Details

Type

`\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
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

`$rdbms= ''`

RDBMS Product needed for this SQL.

Details

Type

`\Target $target= ''`
inherited

owning Target objectInherited from: \Task::$target
Details

Type
  \Target
Inherited_from
  \Task::$target

`string $taskName= ''`
inherited

Taskname for loggerInherited from: \Task::$taskName
Details

Type
  string
Inherited_from
  \Task::$taskName

`string $taskType= ''`
inherited

internal taskname (req)Inherited from: \Task::$taskType
Details

Type
  string
Inherited_from
  \Task::$taskType

`$url= ''`

DB url.

Details

Type

`$userId= ''`

User name.

Details

Type

`\RuntimeConfigurable $wrapper= ''`
inherited

wrapper of the taskInherited from: \Task::$wrapper
Details

Type
  \RuntimeConfigurable
Inherited_from
  \Task::$wrapper

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

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.

`getDescription( ) : string`
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns

Type | Description
--- | ---
string | The text description of the task

`getLoaderMap( ) : void`

`getLocation( ) : \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.

`getOwningTarget( ) : \Target`
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns

Type | Description
--- | ---
\Target | The target object that owns this task

`getPassword( ) : \Returns`

Gets the password.

Returns

Type | Description
--- | ---
\Returns | a String

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getRegisterSlot( $slotName ) : void`
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters

Name | Type | Description
--- | --- | ---
$slotName |  |

`getRuntimeConfigurableWrapper( ) : \RuntimeConfigurable`
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns

Type | Description
--- | ---
\RuntimeConfigurable | The wrapper object used by this task

`getTaskName( ) : string`
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns

Type | Description
--- | ---
string | Name of this task

`getTaskType( ) : 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)

`getUrl( ) : \Returns`

Gets the url.

Returns

Type | Description
--- | ---
\Returns | a String

`getUserId( ) : \Returns`

Gets the userId.

Returns

Type | Description
--- | ---
\Returns | a String

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

Throws

Exception | Description
--- | ---
\BuildException |

`isAutocommit( ) : \Returns`

Gets the autocommit.

Returns

Type | Description
--- | ---
\Returns | a boolean

`isCaching( $value ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

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

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg | string | The message to log
$level | integer | The priority of the message

Details

See
  \BuildEvent
See
  \BuildListener

`main( ) : void`
abstract inherited

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`
inherited

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

Inherited from: \Task::maybeConfigure()
`perform( ) : void`
inherited

Perfrom this task

Inherited from: \Task::perform()
`setAutocommit( \autocommit $autocommit ) : void`

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

Parameters

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

Parameters

Name | Type | Description
--- | --- | ---
$enable |  |

`setDescription( 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

`setDriver( string $driver ) : void`

Set the Creole driver to be used.

Parameters

Name | Type | Description
--- | --- | ---
$driver | string | driver class name

`setLocation( \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.

`setOwningTarget( \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

`setPassword( \password $password ) : void`

Sets the password; required.

Parameters

Name | Type | Description
--- | --- | ---
$password | \password | The password to set

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`setRuntimeConfigurableWrapper( \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

`setTaskName( $name ) : string`
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

Returns

Type | Description
--- | ---
string | A string representing the name of this task for log

`setTaskType( 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)

`setUrl( \url $url ) : void`

Sets the database connection URL; required.

Parameters

Name | Type | Description
--- | --- | ---
$url | \url | The url to set

`setUserid( \userId $userId ) : void`

Set the user name for the connection; required.

Parameters

Name | Type | Description
--- | --- | ---
$userId | \userId | The userId to set

`setVersion( \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.15.1.