Docs For Class PhpFunk_DB

Interface PhpFunk_DB_DBWrapper

Description

DB abstraction layer

DB abstraction layer similar to perl DBI in that it allows for placeholder ? type SQL statements.

PHP version 5

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the phpfunk.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

version: CVS: $Id: DBWrapper.php,v 1.5 2008/03/21 03:26:35 tom Exp $
copyright: Copyright 2006-2008 Tom Pimienta
usedby: PhpFunk_DB_TableDataGateway
license: BSD

Located in /DB/DBWrapper.php (line 46)

Method Summary

int affectedRows ()

boolean commit ()

boolean connect (string $host, string $user, string $password, string $database)

void disconnect ()

string escape (string $arg)

int execute (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

void executePrepared (mixed $args)

boolean isConnected ()

string lastError ()

int lastInsertID ()

void prepare (string $sql)

boolean rollback ()

array selectColumn (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

mixed selectOne (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

mixed selectRows (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

boolean startTransaction ()

Methods

affectedRows (line 131)

return: number of rows affected by last query

int affectedRows ()

commit (line 159)

Returns FALSE if unable to commit

boolean commit ()

connect (line 57)

Returns TRUE on successful connection

boolean connect (string $host, string $user, string $password, string $database)

string $host
string $user
string $password
string $database

disconnect (line 62)

void disconnect ()

escape (line 173)

Escape an argument so it can be safely inserted into database

return: quoted $arg

string escape (string $arg)

string $arg

execute (line 110)

return: number of rows affected

int execute (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

string $sql: SQL statement
mixed $args: argument or array of args
string $FILE: name of calling file
int $LINE: line number where called in $FILE

executePrepared (line 126)

Execute a prepared statement.

void executePrepared (mixed $args)

mixed $args: scalar or ordered array

isConnected (line 67)

boolean isConnected ()

lastError (line 138)

Returns last error msg or FALSE if there was none

todo: accumulate errors?

string lastError ()

lastInsertID (line 147)

The driver will attempt to return the last insert ID.

Will return last insert ID or FALSE if feature is not supported.

int lastInsertID ()

prepare (line 119)

Prepare a statement for execution w/ executePrepared()

This is not a real prepared statement, it just stores the SQL client-side

void prepare (string $sql)

string $sql: the SQL statement to store

rollback (line 165)

Returns FALSE if unable to rollback!

boolean rollback ()

selectColumn (line 101)

Get first column of each row in result set.

return: ordered array

array selectColumn (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

string $sql: SQL statement
mixed $args: argument or array of args
string $FILE: name of calling file
int $LINE: line number where called in $FILE

selectOne (line 76)

return: single row, or single value, or FALSE on error

mixed selectOne (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

string $sql: SQL statement
mixed $args: argument or array of args
string $FILE: name of calling file
int $LINE: line number where called in $FILE

selectRows (line 89)

Returns rows of assoc array or NULL if no matches are found.

Returns FALSE on error.

mixed selectRows (string $sql, [mixed $args = ''], [string $FILE = ''], [int $LINE = ''])

string $sql: SQL statement
mixed $args: argument or array of args
string $FILE: name of calling file
int $LINE: line number where called in $FILE

startTransaction (line 153)

Returns FALSE if unable to start transaction

boolean startTransaction ()

Documentation generated on Sun, 08 Jun 2008 22:21:17 -0700 by phpDocumentor 1.4.0