Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __construct
C
 cache, ConnectionCache
 close, DAO
 conn
 connect
 ConnectionCache
 ConnectionFactory
 ConnFactoryException
 current, DataResult
 currentRow, DataResult
D
 da, DAO
 DAO
 DaoException
 DataAccess
 DataAccessError
 DataAccessMysql
 DataAccessMysqli
 DataResult
 DataResultMysql
 DataResultMysqli
 dataSeek
 db
 disconnect
 display
E
 error
 errorMsg, DataAccessError
 errorNum, DataAccessError
 errorType, DataAccessError
 escape
F
 format
 Functions
G
 getAffectedRows
 getEntry, ConnectionCache
 getErrorMsg, DataAccessError
 getErrorNum, DataAccessError
 getErrorStr, DataAccessError
 getErrorType, DataAccessError
 getFormat
 getInstance, ConnectionCache
 getNumFields
 getNumRows
 getRow
I
 instance, ConnectionCache
 isEntry, ConnectionCache
K
 key, DataResult
M
 makeConnection, ConnectionFactory
 methods
N
 next, DataResult
P
 properties, ConnectionCache
Q
 query
R
 removeEntry, ConnectionCache
 result, DataResult
 retrieve, DAO
 rewind, DataResult
 rowNum, DataResult
S
 setEntry, ConnectionCache
 setFormat
U
 update, DAO
private function __construct()
initializes cache
public function __construct($connStr)
creates a connection to the database
public function __construct($errType =  0,
$errNum =  0,
$errMsg =  "")
initializes errorType, errorNum and ErrorMsg
public function __construct($host,
$user,
$pass,
$db)
DataAccessMysql class constructor
public function __construct($host,
$user,
$pass,
$db)
DataAccessMysql class constructor
public function __construct($result)
DataResultMysql constructor
public function __construct($result)
DataResultMysql constructor
private $cache
ArrayObject which holds the DataAccess objects
public function close()
closes database connection and unsets DataAccess object
protected $conn
database connection resource
protected $conn
database connection resource
public function connect($host,
$user,
$pass,
$db)
create a connect to the database
public function connect($host,
$user,
$pass,
$db)
given a hostname, username, password and database name makes a connection to the database and selects the database if the connection cannot be made or the database cannot be selected, throws DAOExcpetion
public function connect($host,
$user,
$pass,
$db)
given a hostname, username, password and database name makes a connection to the database and selects the database if the connection cannot be made or the database cannot be selected, throws DAOExcpetion
singleton which is used to manage DataAccess objects
connection factory handles the creation of database connections and manages them via a connection cache singleton
general purpose exception class used by connection factory class
public function current()
returns current row from dataset (overrides Iterator:: current())
protected $currentRow
ArrayObject holding the current row data
protected $da
DataAccess object
general purpose data access object meant to handle all communcations with the database through DataAccess and DataResult objects
general purpose exception class used by daophp5 classes
interface which all DataAccess class should implement
general purpose error class used by daophp5 classes
DataAccessMysql handles connecting to and querying database using php mysql_* functions
DataAccessMysqli handles connecting to and querying database using php mysqli_* functions
abstract class representing the result object returned from the DataAccess object
DataResultMysql handles retrieving row data from the mysql database
DataResultMysql handles retrieving row data from the mysql database
protected function dataSeek($row_num =  0)
resets cursor to beginning of dataset
protected function dataSeek($row_num =  0)
resets cursor to beginning of dataset
protected $db
database name
protected $db
database name
public function disconnect()
disconnect from the database
public function disconnect()
disconnect database connection
public function disconnect()
disconnect database connection
public function display()
displays exception information
public function display()
displays exception information
private $error
DataAccessError
private $error
DataAccessError
private $errorMsg
error message
private $errorNum
error number
private $errorType
error type
public function escape($val)
escape value used in query string
public function escape($val)
escape a value before using it in a query string
public function escape($val)
escape a value before using it in a query string
private $format
holds the format of the result set, NUM, ASSOC or BOTH @access private @var int row format return type
private $format
holds the format of the result set, NUM, ASSOC or BOTH @access private @var int row format return type
public function getAffectedRows()
returns the number of rows affected by an insert, update or delete query
public function getAffectedRows()
returns the number of rows affected by an insert, update or delete query
public function getEntry($key)
creates/overwrites a DataAccess entry in the cache
public function getErrorMsg()
retrieves error message string
public function getErrorNum()
retrieves error number
public function getErrorStr()
retrieves error message string
public function getErrorType()
retrieves error message
public function getFormat()
gets the result array format
public function getFormat()
gets the result array format
public static function getInstance()
creates and returns instance of ConnectionCache if instance does not exist, otherwise returns instance if instance already exists
abstract public function getNumFields()
public function getNumFields()
returns number of fields in result set
public function getNumFields()
returns number of fields in result set
abstract public function getNumRows()
returns number of rows in result set
public function getNumRows()
returns number of rows from resulting from select query
public function getNumRows()
returns number of rows from resulting from select query
abstract protected function getRow()
returns an ArrayObject containing row data or false if no (more) rows
protected function getRow()
returns a row of data from the mysql database result resource.
protected function getRow()
returns a row of data from the mysql database result resource.
private static $instance
ConnectionCache instance
public function isEntry($key)
verifies if an entry is valid based on its key
public function key()
returns current row number (overrides Iterator::key())
public static function makeConnection($connStr)
creates an instance of the connection cache and returns either an existing DataAccess object or creates and returns a new DataAccess object if it cannot create a new DataAccess object, throws a ConnFactoryException
public function next()
retrieves next row from dataset, places it into currentRow and increments row number (overrides Iterator:: next())
public function query($sql)
send query to the database
public function query($sql)
given an SQL string, queries the database and returns the result or throws DAOException
public function query($sql)
given an SQL string, queries the database and returns the result or throws DAOException
public function removeEntry($conn)
removes an entry from the cache
protected $result
DataResult
public function retrieve($sql)
runs database select query and returns DataResult object
public function rewind()
repositions cursor to beginning of dataset and resets row number (overrides Iterator::rewind())
protected $rowNum
current row number
public function setEntry($key,
$conn)
creates/overwrites a DataAccess entry in the cache
public function setFormat($format)
sets the format of the result array to either 0-indexed (default), associative (with column names) or both
public function setFormat($format)
sets the format of the result array to either 0-indexed (default), associative (with column names) or both
public function update($sql)
runs database insert/update/dete/ query and returns DataResult object