File Source for database.cls.php

<?php
/***********************************************\
* N2F Yverdon v0 *
* Copyright (c) 2009 Zibings Incorporated *
* *
* You should have received a copy of the *
* Microsoft Reciprocal License along with *
* this program. If not, see: *
* <http://opensource.org/licenses/ms-rl.html> *
\***********************************************/
/*
* $Id: database.cls.php 24 2009-09-12 11:41:30Z amale $
*/
global $_n2f_db_extensions;
/**
* Core database class for N2 Framework Yverdon.
*
*/
class n2f_database extends n2f_events {
/**
* Connection resource for this n2f_database object.
*
* @var resource
*/
public $conn;
/**
* Number of queries performed by this n2f_database object.
*
* @var integer
*/
public $queries;
/**
* The extension currently in use by this n2f_database object.
*
* @var string
*/
public $extension;
/**
* Internal container for object data.
*
* @var array
*/
protected $_internalData;
/**
* Static function for adding database extensions to the available list.
*
* @param string $name Name of extension to add
* @param array $callbacks Array of callbacks for extension
* @return null
*/
public static function addExtension($name, array $callbacks) {
if (empty($name)) {
return(null);
}
if (count($callbacks) <> 10 ||
!isset($callbacks[N2F_DBEVT_OPEN_CONNECTION]) || !isset($callbacks[N2F_DBEVT_CLOSE_CONNECTION]) || !isset($callbacks[N2F_DBEVT_CHECK_CONNECTION]) || !isset($callbacks[N2F_DBEVT_ADD_PARAMETER])
|| !isset($callbacks[N2F_DBEVT_EXECUTE_QUERY]) || !isset($callbacks[N2F_DBEVT_GET_ROW]) || !isset($callbacks[N2F_DBEVT_GET_ROWS]) || !isset($callbacks[N2F_DBEVT_GET_LAST_INC])
|| !isset($callbacks[N2F_DBEVT_GET_NUMROWS]) || !isset($callbacks[N2F_DBEVT_GET_RESULT])) {
return(null);
}
global $_n2f_db_extensions;
$_n2f_db_extensions[$name] = array(
N2F_DBEVT_OPEN_CONNECTION => $callbacks[N2F_DBEVT_OPEN_CONNECTION],
N2F_DBEVT_CLOSE_CONNECTION => $callbacks[N2F_DBEVT_CLOSE_CONNECTION],
N2F_DBEVT_CHECK_CONNECTION => $callbacks[N2F_DBEVT_CHECK_CONNECTION],
N2F_DBEVT_ADD_PARAMETER => $callbacks[N2F_DBEVT_ADD_PARAMETER],
N2F_DBEVT_EXECUTE_QUERY => $callbacks[N2F_DBEVT_EXECUTE_QUERY],
N2F_DBEVT_GET_ROW => $callbacks[N2F_DBEVT_GET_ROW],
N2F_DBEVT_GET_ROWS => $callbacks[N2F_DBEVT_GET_ROWS],
N2F_DBEVT_GET_LAST_INC => $callbacks[N2F_DBEVT_GET_LAST_INC],
N2F_DBEVT_GET_NUMROWS => $callbacks[N2F_DBEVT_GET_NUMROWS],
N2F_DBEVT_GET_RESULT => $callbacks[N2F_DBEVT_GET_RESULT]
);
return(null);
}
/**
* Initializes a new n2f_database object.
*
* @param n2f_cls $n2f
* @param string $ext
* @return n2f_database
*/
public function __construct(n2f_cls &$n2f, $ext) {
parent::__construct();
$this->conn = null;
$this->queries = 0;
$this->_internalData = array();
global $_n2f_db_extensions;
$this->addEvent(N2F_DBEVT_CONNECTION_OPENED);
$this->addEvent(N2F_DBEVT_CONNECTION_CLOSED);
$this->addEvent(N2F_DBEVT_QUERY_CREATED);
$this->addEvent(N2F_DBEVT_OPEN_CONNECTION, true);
$this->addEvent(N2F_DBEVT_CLOSE_CONNECTION, true);
$this->addEvent(N2F_DBEVT_CHECK_CONNECTION, true);
if (!isset($_n2f_db_extensions[$ext])) {
if ($n2f->debug->showLevel(N2F_DEBUG_ERROR)) {
$n2f->debug->throwError(N2F_ERROR_DB_EXTENSION_NOT_LOADED, S('N2F_ERROR_DB_EXTENSION_NOT_LOADED', array($ext)), 'system/classes/database.cls.php');
}
$this->extension = null;
} else {
$this->hookEvent(N2F_DBEVT_OPEN_CONNECTION, $_n2f_db_extensions[$ext][N2F_DBEVT_OPEN_CONNECTION]);
$this->hookEvent(N2F_DBEVT_CLOSE_CONNECTION, $_n2f_db_extensions[$ext][N2F_DBEVT_CLOSE_CONNECTION]);
$this->hookEvent(N2F_DBEVT_CHECK_CONNECTION, $_n2f_db_extensions[$ext][N2F_DBEVT_CHECK_CONNECTION]);
$this->extension = $ext;
}
return($this);
}
/**
* Mechanism for storing data in the n2f_database object's internal data container.
*
* @param mixed $key
* @param mixed $data
* @return n2f_database
*/
public function addData($key, $data) {
$this->_internalData[$key] = $data;
return($this);
}
/**
* Retrieves data from the n2f_database object's internal data container.
*
* @param mixed $key
* @return mixed
*/
public function getData($key) {
if (isset($this->_internalData[$key])) {
return($this->_internalData[$key]);
}
return(null);
}
/**
* Opens the connection for this n2f_database object.
*
* @param array $args
* @return n2f_database
*/
public function open() {
global $n2f;
$this->hitEvent(N2F_DBEVT_OPEN_CONNECTION, array(&$this, $n2f->cfg->db));
$this->hitEvent(N2F_DBEVT_CONNECTION_OPENED, array(&$this));
if ($n2f->debug->showLevel(N2F_DEBUG_NOTICE)) {
$n2f->debug->throwNotice(N2F_NOTICE_DB_CONNECTION_OPENED, S('N2F_NOTICE_DB_CONNECTION_OPENED', array($this->extension)), 'system/classes/database.cls.php');
}
return($this);
}
/**
* Closes the connection for this n2f_database object.
*
* @return n2f_database
*/
public function close() {
global $n2f;
$this->hitEvent(N2F_DBEVT_CLOSE_CONNECTION, array(&$this));
$this->hitEvent(N2F_DBEVT_CONNECTION_CLOSED, array(&$this));
$this->conn = null;
if ($n2f->debug->showLevel(N2F_DEBUG_NOTICE)) {
$n2f->debug->throwNotice(N2F_NOTICE_DB_CONNECTION_CLOSED, S('N2F_NOTICE_DB_CONNECTION_CLOSED', array($this->extension)), 'system/classes/database.cls.php');
}
return($this);
}
/**
* Returns true or false based on whether or not the object's connection is active.
*
* @return boolean
*/
public function isOpen() {
return((bool)$this->hitEvent(N2F_DBEVT_CHECK_CONNECTION, array(&$this)));
}
/**
* Produces a new n2f_database_query object from the given query.
*
* @param string $sql
* @return n2f_database_query
*/
public function query($sql, $options = null) {
$result = new n2f_database_query($sql, $this, $options);
$this->hitEvent(N2F_DBEVT_QUERY_CREATED, array($result, &$this));
return($result);
}
}
/**
* Core database query class for N2 Framework Yverdon.
*
*/
class n2f_database_query extends n2f_events {
/**
* Internal reference to the global database handler.
*
* @var n2f_database
*/
public $db;
/**
* SQL string used for this query.
*
* @var string
*/
public $query;
/**
* Collection of parameters for the current query.
*
* @var array
*/
public $params;
/**
* Holds the current result set for the query if applicable.
*
* @var result
*/
public $result;
/**
* Latest error returned by the query.
*
* @var array
*/
private $_errors;
/**
* Internal container for object data.
*
* @var array
*/
protected $_internalData;
/**
* Initializes a new n2f_database_query object.
*
* @param string $sql
* @param n2f_database $db
* @return n2f_database_query
*/
public function __construct($sql, n2f_database &$db, $options = null) {
global $n2f, $_n2f_db_extensions;
parent::__construct();
$this->db = $db;
$this->query = $sql;
$this->errors = array();
$this->params = array();
$this->result = null;
$this->_internalData = array();
$this->addData('options', $options);
$this->addEvent(N2F_DBEVT_PARAMETER_ADDED);
$this->addEvent(N2F_DBEVT_QUERY_EXECUTED);
$this->addEvent(N2F_DBEVT_ROW_RETRIEVED);
$this->addEvent(N2F_DBEVT_ROWS_RETRIEVED);
$this->addEvent(N2F_DBEVT_LAST_INC_RETRIEVED);
$this->addEvent(N2F_DBEVT_NUMROWS_RETRIEVED);
$this->addEvent(N2F_DBEVT_RESULT_RETRIEVED);
$this->addEvent(N2F_DBEVT_ADD_PARAMETER, true);
$this->addEvent(N2F_DBEVT_EXECUTE_QUERY, true);
$this->addEvent(N2F_DBEVT_GET_ROW, true);
$this->addEvent(N2F_DBEVT_GET_ROWS, true);
$this->addEvent(N2F_DBEVT_GET_LAST_INC, true);
$this->addEvent(N2F_DBEVT_GET_NUMROWS, true);
$this->addEvent(N2F_DBEVT_GET_RESULT, true);
if ($db->extension === null || empty($db->extension)) {
if ($n2f->debug->showLevel(N2F_DEBUG_ERROR)) {
$n2f->debug->throwError(N2F_ERROR_DB_EXTENSION_EMPTY, S('N2F_ERROR_DB_EXTENSION_EMPTY'), 'system/classes/database.cls.php');
}
} else if ($db->isOpen() !== true) {
if ($n2f->debug->showLevel(N2F_DEBUG_ERROR)) {
$n2f->debug->throwError(N2F_ERROR_DB_NOT_LOADED, S('N2F_ERROR_DB_NOT_LOADED'), 'system/classes/database.cls.php');
}
} else {
$this->hookEvent(N2F_DBEVT_ADD_PARAMETER, $_n2f_db_extensions[$db->extension][N2F_DBEVT_ADD_PARAMETER]);
$this->hookEvent(N2F_DBEVT_EXECUTE_QUERY, $_n2f_db_extensions[$db->extension][N2F_DBEVT_EXECUTE_QUERY]);
$this->hookEvent(N2F_DBEVT_GET_ROW, $_n2f_db_extensions[$db->extension][N2F_DBEVT_GET_ROW]);
$this->hookEvent(N2F_DBEVT_GET_ROWS, $_n2f_db_extensions[$db->extension][N2F_DBEVT_GET_ROWS]);
$this->hookEvent(N2F_DBEVT_GET_LAST_INC, $_n2f_db_extensions[$db->extension][N2F_DBEVT_GET_LAST_INC]);
$this->hookEvent(N2F_DBEVT_GET_NUMROWS, $_n2f_db_extensions[$db->extension][N2F_DBEVT_GET_NUMROWS]);
$this->hookEvent(N2F_DBEVT_GET_RESULT, $_n2f_db_extensions[$db->extension][N2F_DBEVT_GET_RESULT]);
}
if ($n2f->debug->showLevel(N2F_DEBUG_NOTICE)) {
$n2f->debug->throwNotice(N2F_NOTICE_DB_QUERY_CREATED, S('N2F_NOTICE_DB_QUERY_CREATED', array($db->extension, $sql)), 'system/classes/database.cls.php');
}
return($this);
}
/**
* Mechanism for storing data in the n2f_database_query object's internal data container.
*
* @param mixed $key
* @param mixed $data
* @return n2f_database
*/
public function addData($key, $data) {
$this->_internalData[$key] = $data;
return($this);
}
/**
* Retrieves data from the n2f_database_query object's internal data container.
*
* @param mixed $key
* @return mixed
*/
public function getData($key) {
if (isset($this->_internalData[$key])) {
return($this->_internalData[$key]);
}
return(null);
}
/**
* Adds a parameter to the query stack.
*
* @param string $key
* @param mixed $value
* @param mixed $type
* @return n2f_database_query
*/
public function addParam($key, $value, $type) {
global $n2f;
$result = $this->hitEvent(N2F_DBEVT_ADD_PARAMETER, array(&$this, $key, $value, $type));
if ($result !== false && $n2f->cfg->dbg->level >= N2F_DEBUG_NOTICE) {
$n2f->debug->throwNotice(N2F_NOTICE_DB_PARAMETER_ADDED, S('N2F_NOTICE_DB_PARAMETER_ADDED', array($key)), 'system/classes/database.cls.php');
}
return($this);
}
/**
* Adds an array of parameters to the query stack.
*
* @param array $params
* @return n2f_database_query
*/
public function addParams(array $params) {
global $n2f;
if (count($params) < 1) {
if ($n2f->debug->showLevel(N2F_DEBUG_WARN)) {
$n2f->debug->throwWarning(N2F_WARN_DB_PARAMETERS_NOT_SUPPLIED, S('N2F_WARN_DB_PARAMETERS_NOT_SUPPLIED', array($this->query)), 'system/classes/database.cls.php');
}
return($this);
}
foreach (array_values($params) as $param) {
if (count($param) != 3) {
if ($n2f->debug->showLevel(N2F_DEBUG_WARN)) {
$n2f->debug->throwWarning(N2F_WARN_DB_INVALID_PARAMETER, S('N2F_WARN_DB_INVALID_PARAMETER', array(debugEcho($param))), 'system/classes/database.cls.php');
}
continue;
}
$this->addParam($param[0], $param[1], $param[2]);
}
return($this);
}
/**
* Executes the query.
*
* @return n2f_database_query
*/
public function execQuery() {
global $n2f;
if (count($this->_errors) < 1) {
$this->hitEvent(N2F_DBEVT_EXECUTE_QUERY, array(&$this));
$this->db->queries += 1;
if ($n2f->cfg->dbg->level >= N2F_DEBUG_NOTICE) {
$n2f->debug->throwNotice(N2F_NOTICE_DB_QUERY_EXECUTED, S('N2F_NOTICE_DB_QUERY_EXECUTED'), 'system/classes/database.cls.php');
}
}
return($this);
}
/**
* Adds an error to the n2f_database_query object's error stack.
*
* @param string $string
* @return n2f_database_query
*/
public function addError($string) {
if (empty($string)) {
return($this);
}
$this->_errors[] = $string;
return($this);
}
/**
* Returns true or false based on whether or not an error has occurred.
*
* @return boolean
*/
public function isError() {
if (count($this->_errors) > 0) {
return(true);
}
return(false);
}
/**
* Returns the last populated error string.
*
* @return string
*/
public function fetchError() {
return($this->_errors[count($this->_errors) - 1]);
}
/**
* Returns the error stack.
*
* @return array
*/
public function fetchErrors() {
return($this->_errors);
}
/**
* Fetches a single row from the result.
*
* @return mixed
*/
public function fetchRow() {
return($this->hitEvent(N2F_DBEVT_GET_ROW, array(&$this)));
}
/**
* Fetches all rows from the result.
*
* @return mixed
*/
public function fetchRows() {
return($this->hitEvent(N2F_DBEVT_GET_ROWS, array(&$this)));
}
/**
* Fetches a specific field from the result.
*
* @param integer $offset
* @param string $field_name
* @return mixed
*/
public function fetchResult($offset, $field_name) {
return($this->hitEvent(N2F_DBEVT_GET_RESULT, array(&$this, $offset, $field_name)));
}
/**
* Fetches the last automatically incremented value from the query (if applicable).
*
* @return mixed
*/
public function fetchInc($params = null) {
if ($params !== null) {
return($this->hitEvent(N2F_DBEVT_GET_LAST_INC, array(&$this, $params)));
}
return($this->hitEvent(N2F_DBEVT_GET_LAST_INC, array(&$this)));
}
/**
* Returns the number of rows from the result.
*
* @return integer
*/
public function numRows() {
return($this->hitEvent(N2F_DBEVT_GET_NUMROWS, array(&$this)));
}
}
?>

Documentation generated on Sat, 23 Jan 2010 11:13:34 -0500 by phpDocumentor 1.4.1

Source for file database.cls.php