Class: CreoleDatabase

Source Location: /database/CreoleDatabase.class.php

ParameterHolder
   |
   --Database
      |
      --CreoleDatabase

CreoleDatabase provides connectivity for the Creole database abstraction layer.

Database::connect(): Connect to the database.
Database::getConnection(): Retrieve the database connection associated with this Database implementation.
Database::getResource(): Retrieve a raw database resource associated with this Database implementation.
Database::initialize(): Initialize this Database.
Database::shutdown(): Execute the shutdown procedure.

ParameterHolder::clearParameters(): Clear all parameters associated with this request.
ParameterHolder::getParameter(): Retrieve a parameter.
ParameterHolder::getParameterNames(): Retrieve an array of parameter names.
ParameterHolder::getParameters(): Retrieve an array of parameters.
ParameterHolder::hasParameter(): Indicates whether or not a parameter exists.
ParameterHolder::removeParameter(): Remove a parameter.
ParameterHolder::setParameter(): Set a parameter.
ParameterHolder::setParameterByRef(): Set a parameter by reference.
ParameterHolder::setParameters(): Set an array of parameters.
ParameterHolder::setParametersByRef(): Set an array of parameters by reference.

[line 51]
CreoleDatabase provides connectivity for the Creole database abstraction layer.

Optional parameters:

classpath - [none] - An absolute filesystem path to the main Creole class file.
database - [none] - The database name.
dsn - [none] - The DSN formatted connection string.
hostspec - [none] - The database host specifications.
method - [normal] - How to read connection parameters. Possible values are dsn, normal, server, and env. The dsn method reads them from the dsn parameter. The normal method reads them from the specified values. server reads them from $_SERVER where the keys to retrieve the values are what you specify the value as in the settings. env reads them from $_ENV and works like $_SERVER.
no_assoc_lower - [Off] - Turn off portabilty of resultset field names.
password - [none] - The database password.
persistent - [No] - Indicates that the connection should persistent.
phptype - [none] - The type of database (mysql, pgsql, etc).
username - [none] - The database user.

version:	$Id: CreoleDatabase.class.php 743 2005-01-06 15:53:16Z seank $
since:	3.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

void connect(
)

Connect to the database.

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	DatabaseException If a connection could not be created.

Overrides Database::connect() (Connect to the database.)

[ Top ]

void shutdown(
)

Execute the shutdown procedure.

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	DatabaseException If an error occurs while shutting down this database.

Overrides Database::shutdown() (Execute the shutdown procedure.)

[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:14 +0900 by phpDocumentor 1.3.0RC5