mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]

Class: PostgreSQLDatabase

Source Location: /database/PostgreSQLDatabase.class.php

Class Overview

ParameterHolder
   |
   --Database
      |
      --PostgreSQLDatabase

PostgreSQLDatabase provides connectivity for the PostgreSQL brand database.


Author(s):

  • Sean Kerr (skerr@mojavi.org)

Version:

  • $Id: PostgreSQLDatabase.class.php 743 2005-01-06 15:53:16Z seank $

Copyright:

Methods


Inherited Variables

Inherited Methods

Class: Database

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.

Class: ParameterHolder

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.

Class Details

[line 42]
PostgreSQLDatabase provides connectivity for the PostgreSQL brand database.

Optional parameters:

  • database - [none] - The database name.
  • host - [localhost] - The database host.
  • method - [normal] - How to read connection parameters. Possible values are normal, server, and env. 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.
  • password - [none] - The database password.
  • persistent - [No] - Indicates that the connection should be persistent.
  • port - [none] - TCP/IP port on which PostgreSQL is listening.
  • user - [none] - The database user.




Tags:

version:  $Id: PostgreSQLDatabase.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 ]


Class Methods


method connect [line 57]

void connect( )

Connect to the database.



Tags:

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 ]

method shutdown [line 176]

void shutdown( )

Execute the shutdown procedure.



Tags:

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:24 +0900 by phpDocumentor 1.3.0RC5