onPHP

DB Class Reference

home about examples API documentation download forum contacts
 

DB Class Reference
[Connectors and dialects for various databases]

DB-connector's implementation basis. More...

Inheritance diagram for DB:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 connect ()
 disconnect ()
 getTableInfo ($table)
 queryRaw ($queryString)
 queryRow (Query $query)
 querySet (Query $query)
 queryColumn (Query $query)
 queryCount (Query $query)
 setDbEncoding ()
 __destruct ()
 getLink ()
 isConnected ()
 hasSequences ()
 hasQueue ()
 isPersistent ()
 setPersistent ($really=false)
 setUsername ($name)
 setPassword ($password)
 setHostname ($host)
 setBasename ($base)
 setEncoding ($encoding)
 begin ($level=null, $mode=null)
 transaction handling
 commit ()
 rollback ()
 inTransaction ()
 queueStart ()
 queue handling
 queueStop ()
 queueDrop ()
 queueFlush ()
 isQueueActive ()
 query (Query $query)
 base queries
 queryNull (Query $query)

Static Public Member Functions

static getDialect ()
static spawn ($connector, $user, $pass, $host, $base=null, $persistent=false, $encoding=null)
 Shortcut.

Public Attributes

const FULL_TEXT_AND = 1
const FULL_TEXT_OR = 2

Protected Attributes

 $link = null
 $persistent = false
 $username = null
 $password = null
 $hostname = null
 $port = null
 $basename = null
 $encoding = null

Private Attributes

 $transaction = false
 flag to indicate whether we're in transaction
 $queue = array()
 $toQueue = false

Detailed Description

DB-connector's implementation basis.

Definition at line 18 of file DB.class.php.

Constructor & Destructor Documentation

DB::__destruct (  ) 

Definition at line 58 of file DB.class.php.

References disconnect(), isConnected(), and rollback().

Here is the call graph for this function:

Member Function Documentation

DB::connect (  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

DB::disconnect (  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

Referenced by __destruct().

DB::getTableInfo ( $  table  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

DB::queryRaw ( $  queryString  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

Referenced by begin(), commit(), Sequenceless::query(), query(), queueFlush(), rollback(), and Queue::run().

DB::queryRow ( Query $  query  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

DB::querySet ( Query $  query  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

DB::queryColumn ( Query $  query  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

DB::queryCount ( Query $  query  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

DB::setDbEncoding (  )  [abstract]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

static DB::getDialect (  )  [static]

Reimplemented in MySQL, MySQLim, PgSQL, and SQLite.

Definition at line 69 of file DB.class.php.

Referenced by Sequenceless::query(), query(), and queryNull().

static DB::spawn ( $  connector,
$  user,
$  pass,
$  host,
$  base = null,
$  persistent = false,
$  encoding = null 
) [static]

Shortcut.

Returns:
DB

Definition at line 79 of file DB.class.php.

References $encoding, $persistent, setBasename(), setEncoding(), setHostname(), setPassword(), setPersistent(), and setUsername().

Here is the call graph for this function:

DB::getLink (  ) 

Definition at line 97 of file DB.class.php.

DB::begin ( $  level = null,
$  mode = null 
)

transaction handling

Deprecated:
by Transaction class
Returns:
DB

Definition at line 110 of file DB.class.php.

References queryRaw().

Here is the call graph for this function:

DB::commit (  ) 

Returns:
DB

Definition at line 136 of file DB.class.php.

References queryRaw().

Here is the call graph for this function:

DB::rollback (  ) 

Returns:
DB

Definition at line 151 of file DB.class.php.

References queryRaw().

Referenced by __destruct().

Here is the call graph for this function:

DB::inTransaction (  ) 

Definition at line 163 of file DB.class.php.

DB::queueStart (  ) 

queue handling

Deprecated:
by Queue class
Returns:
DB

Definition at line 177 of file DB.class.php.

References hasQueue().

Here is the call graph for this function:

DB::queueStop (  ) 

Returns:
DB

Definition at line 188 of file DB.class.php.

DB::queueDrop (  ) 

Returns:
DB

Definition at line 198 of file DB.class.php.

Referenced by queueFlush().

DB::queueFlush (  ) 

Returns:
DB

Definition at line 208 of file DB.class.php.

References queryRaw(), and queueDrop().

Here is the call graph for this function:

DB::isQueueActive (  ) 

Definition at line 220 of file DB.class.php.

DB::query ( Query $  query  ) 

base queries

Reimplemented in Sequenceless.

Definition at line 230 of file DB.class.php.

References getDialect(), and queryRaw().

Referenced by PgSQL::queryColumn(), queryNull(), PgSQL::queryRow(), and PgSQL::querySet().

Here is the call graph for this function:

DB::queryNull ( Query $  query  ) 

Definition at line 235 of file DB.class.php.

References getDialect(), query(), and DialectString::toDialectString().

Referenced by SQLite::queryCount(), PgSQL::queryCount(), MySQLim::queryCount(), and MySQL::queryCount().

Here is the call graph for this function:

DB::isConnected (  ) 

Reimplemented in PgSQL, and SQLite.

Definition at line 250 of file DB.class.php.

Referenced by __destruct(), MySQLim::disconnect(), and MySQL::disconnect().

DB::hasSequences (  ) 

Reimplemented in PgSQL.

Definition at line 255 of file DB.class.php.

DB::hasQueue (  ) 

Reimplemented in MySQL, MySQLim, and SQLite.

Definition at line 260 of file DB.class.php.

Referenced by queueStart().

DB::isPersistent (  ) 

Definition at line 265 of file DB.class.php.

DB::setPersistent ( $  really = false  ) 

Returns:
DB

Definition at line 273 of file DB.class.php.

Referenced by spawn().

DB::setUsername ( $  name  ) 

Returns:
DB

Definition at line 283 of file DB.class.php.

Referenced by spawn().

DB::setPassword ( $  password  ) 

Returns:
DB

Definition at line 293 of file DB.class.php.

References $password.

Referenced by spawn().

DB::setHostname ( $  host  ) 

Returns:
DB

Definition at line 303 of file DB.class.php.

References $port.

Referenced by spawn().

DB::setBasename ( $  base  ) 

Returns:
DB

Definition at line 319 of file DB.class.php.

Referenced by spawn().

DB::setEncoding ( $  encoding  ) 

Returns:
DB

Definition at line 329 of file DB.class.php.

References $encoding.

Referenced by spawn().

Member Data Documentation

const DB::FULL_TEXT_AND = 1

Definition at line 20 of file DB.class.php.

Referenced by Expression::fullTextAnd(), Expression::fullTextRankAnd(), and PostgresDialect::prepareFullText().

const DB::FULL_TEXT_OR = 2

Definition at line 21 of file DB.class.php.

Referenced by Expression::fullTextOr(), and Expression::fullTextRankOr().

DB::$link = null [protected]

Definition at line 23 of file DB.class.php.

DB::$persistent = false [protected]

Definition at line 25 of file DB.class.php.

Referenced by spawn().

DB::$username = null [protected]

Definition at line 28 of file DB.class.php.

DB::$password = null [protected]

Definition at line 29 of file DB.class.php.

Referenced by setPassword().

DB::$hostname = null [protected]

Definition at line 30 of file DB.class.php.

DB::$port = null [protected]

Definition at line 31 of file DB.class.php.

Referenced by setHostname().

DB::$basename = null [protected]

Definition at line 32 of file DB.class.php.

DB::$encoding = null [protected]

Definition at line 33 of file DB.class.php.

Referenced by setEncoding(), and spawn().

DB::$transaction = false [private]

flag to indicate whether we're in transaction

Definition at line 38 of file DB.class.php.

DB::$queue = array() [private]

Definition at line 40 of file DB.class.php.

DB::$toQueue = false [private]

Definition at line 41 of file DB.class.php.

The documentation for this class was generated from the following file:

generated by doxygen-1.5.5
for onPHP at Thu Aug 7 18:21:13 2008