- md5
- 08a6b7ca38983db808d3cc98c42d1468
- sha1
- c2ab5161a2bce5f48b2330b76e4687a23d2239c7
- sha256
- a7efdd7814ff6447347d203c9d54f082a4e1e0652432721d691fc79651b22700
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617
<?php
/**
* @package Joomla.Platform
* @subpackage Database
*
* @copyright Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
JLoader::register('DatabaseException', JPATH_PLATFORM.'/joomla/database/databaseexception.php');
jimport('joomla.filesystem.folder');
interface JDatabaseInterface {
/**
* Test to see if the connector is available.
*
* @return bool True on success, false otherwise.
*
* @since 11.1
*/
static function test();
}
/**
* Database connector class.
*
* @package Joomla.Platform
* @subpackage Database
* @since 11.1
*/
abstract class JDatabase implements JDatabaseInterface
{
/**
* @var string The name of the database driver.
* @since 11.1
*/
public $name;
/**
* @var resource The database connection resource.
* @since 11.1
*/
protected $connection;
/**
* @var integer The number of SQL statements executed by the database driver.
* @since 11.1
*/
protected $count = 0;
/**
* @var resource The database connection cursor from the last query.
* @since 11.1
*/
protected $cursor;
/**
* @var bool The database driver debugging state.
* @since 11.1
*/
protected $debug = false;
/**
* @var integer The affected row limit for the current SQL statement.
* @since 11.1
*/
protected $limit = 0;
/**
* @var array The log of executed SQL statements by the database driver.
* @since 11.1
*/
protected $log = array();
/**
* @var string The character(s) used to quote SQL statement names such as table names or field names,
* etc. The child classes should define this as necessary. If a single character string the
* same character is used for both sides of the quoted name, else the first character will be
* used for the opening quote and the second for the closing quote.
* @since 11.1
*/
protected $nameQuote;
/**
* @var string The null or zero representation of a timestamp for the database driver. This should be
* defined in child classes to hold the appropriate value for the engine.
* @since 11.1
*/
protected $nullDate;
/**
* @var integer The affected row offset to apply for the current SQL statement.
* @since 11.1
*/
protected $offset = 0;
/**
* @var mixed The current SQL statement to execute.
* @since 11.1
*/
protected $sql;
/**
* @var string The common database table prefix.
* @since 11.1
*/
protected $tablePrefix;
/**
* @var bool True if the database engine supports UTF-8 character encoding.
* @since 11.1
*/
protected $utf = false;
/**
* @var integer The database error number
* @since 11.1
* @deprecated 12.1
*/
protected $errorNum = 0;
/**
* @var string The database error message
* @since 11.1
* @deprecated 12.1
*/
protected $errorMsg;
/**
* @var bool If true then there are fields to be quoted for the query.
* @since 11.1
* @deprecated 12.1
*/
protected $hasQuoted = false;
/**
* @var array The fields that are to be quoted.
* @since 11.1
* @deprecated 12.1
*/
protected $quoted = array();
/**
* @var array JDatabase instances container.
* @since 11.1
*/
protected static $instances = array();
/**
* Get a list of available database connectors. The list will only be populated with connectors that both
* the class exists and the static test method returns true. This gives us the ability to have a multitude
* of connector classes that are self-aware as to whether or not they are able to be used on a given system.
*
* @return array An array of available database connectors.
*
* @since 11.1
*/
public static function getConnectors()
{
// Instantiate variables.
$connectors = array();
// Get a list of types.
$types = JFolder::folders(dirname(__FILE__));
// Loop through the types and find the ones that are available.
foreach($types as $type)
{
// Ignore some folders.
if (($type == 'database') || ($type == 'table') || ($type == '.') || ($type == '..')) {
continue;
}
// Derive the class name from the type.
$class = 'JDatabaseDriver'.ucfirst(trim($type));
// If the class doesn't exist, let's look for it and register it.
if (!class_exists($class)) {
// Derive the file path for the driver class.
$path = dirname(__FILE__).'/'.$type.'/driver.php';
// If the file exists register the class with our class loader.
if (file_exists($path)) {
JLoader::register($class, $path);
}
// If it doesn't exist we are at an impasse so move on to the next type.
else {
continue;
}
}
// If the class still doesn't exist we have nothing left to do but look at the next type. We did our best.
if (!class_exists($class)) {
continue;
}
// Sweet! Our class exists, so now we just need to know if it passes it's test method.
if (call_user_func_array(array($class, 'test'), array())) {
$connectors[] = $type;
}
}
return $connectors;
}
/**
* Method to return a JDatabase instance based on the given options. There are three global options and then
* the rest are specific to the database driver. The 'driver' option defines which JDatabaseDriver class is
* used for the connection -- the default is 'mysql'. The 'database' option determines which database is to
* be used for the connection. The 'select' option determines whether the connector should automatically select
* the chosen database.
*
* Instances are unique to the given options and new objects are only created when a unique options array is
* passed into the method. This ensures that we don't end up with unnecessary database connection resources.
*
* @param array $options Parameters to be passed to the database driver.
*
* @return JDatabase A database object.
*
* @since 11.1
*/
public static function getInstance($options = array())
{
// Sanitize the database connector options.
$options['driver'] = (isset($options['driver'])) ? preg_replace('/[^A-Z0-9_\.-]/i', '', $options['driver']) : 'mysql';
$options['database'] = (isset($options['database'])) ? $options['database'] : null;
$options['select'] = (isset($options['select'])) ? $options['select'] : true;
// Get the options signature for the database connector.
$signature = md5(serialize($options));
// If we already have a database connector instance for these options then just use that.
if (empty(self::$instances[$signature])) {
// Derive the class name from the driver.
$class = 'JDatabase'.ucfirst($options['driver']);
// If the class doesn't exist, let's look for it and register it.
if (!class_exists($class)) {
// Derive the file path for the driver class.
$path = dirname(__FILE__).'/database/'.$options['driver'].'.php';
// If the file exists register the class with our class loader.
if (file_exists($path)) {
JLoader::register($class, $path);
}
// If it doesn't exist we are at an impasse so throw an exception.
else {
// Legacy error handling switch based on the JError::$legacy switch.
// @deprecated 12.1
if (JError::$legacy) {
JError::setErrorHandling(E_ERROR, 'die');
return JError::raiseError(500, JText::sprintf('JLIB_DATABASE_ERROR_LOAD_DATABASE_DRIVER', $options['driver']));
}
else {
throw new DatabaseException(JText::sprintf('JLIB_DATABASE_ERROR_LOAD_DATABASE_DRIVER', $options['driver']));
}
}
}
// If the class still doesn't exist we have nothing left to do but throw an exception. We did our best.
if (!class_exists($class)) {
// Legacy error handling switch based on the JError::$legacy switch.
// @deprecated 12.1
if (JError::$legacy) {
JError::setErrorHandling(E_ERROR, 'die');
return JError::raiseError(500, JText::sprintf('JLIB_DATABASE_ERROR_LOAD_DATABASE_DRIVER', $options['driver']));
}
else {
throw new DatabaseException(JText::sprintf('JLIB_DATABASE_ERROR_LOAD_DATABASE_DRIVER', $options['driver']));
}
}
// Create our new JDatabase connector based on the options given.
try {
$instance = new $class($options);
}
catch (DatabaseException $e) {
// Legacy error handling switch based on the JError::$legacy switch.
// @deprecated 12.1
if (JError::$legacy) {
JError::setErrorHandling(E_ERROR, 'ignore');
return JError::raiseError(500, JText::sprintf('JLIB_DATABASE_ERROR_CONNECT_DATABASE', $e->getMessage()));
}
else {
throw new DatabaseException(JText::sprintf('JLIB_DATABASE_ERROR_CONNECT_DATABASE', $e->getMessage()));
}
}
// Set the new connector to the global instances based on signature.
self::$instances[$signature] = $instance;
}
return self::$instances[$signature];
}
/**
* Splits a string of multiple queries into an array of individual queries.
*
* @param string Input SQL string with which to split into individual queries.
*
* @return array The queries from the input string separated into an array.
*
* @since 11.1
*/
public static function splitSql($sql)
{
$start = 0;
$open = false;
$char = '';
$end = strlen($sql);
$queries = array();
for ($i = 0; $i < $end; $i++)
{
$current = substr($sql, $i, 1);
if (($current == '"' || $current == '\'')) {
$n = 2;
while (substr($sql, $i - $n + 1, 1) == '\\' && $n < $i)
{
$n ++;
}
if ($n%2==0) {
if ($open) {
if ($current == $char) {
$open = false;
$char = '';
}
} else {
$open = true;
$char = $current;
}
}
}
if (($current == ';' && !$open)|| $i == $end - 1) {
$queries[] = substr($sql, $start, ($i - $start + 1));
$start = $i + 1;
}
}
return $queries;
}
/**
* Magic method to provide method alias support for quote() and quoteName().
*
* @param string $method The called method.
* @param array $args The array of arguments passed to the method.
*
* @return string The aliased method's return value or null.
*
* @since 11.1
*/
public function __call($method, $args)
{
if (empty($args)) {
return;
}
switch ($method)
{
case 'q':
return $this->quote($args[0], isset($args[1]) ? $args[1] : true);
break;
case 'nq':
case 'qn':
return $this->quoteName($args[0]);
break;
}
}
/**
* Constructor.
*
* @param array $options List of options used to configure the connection
*
* @return void
*
* @since 11.1
*/
protected function __construct($options)
{
// Initialise object variables.
$this->tablePrefix = (isset($options['prefix'])) ? $options['prefix'] : 'jos_';
$this->count = 0;
$this->errorNum = 0;
$this->log = array();
$this->quoted = array();
$this->hasQuoted = false;
// Determine UTF-8 support.
$this->utf = $this->hasUTF();
// Set charactersets (needed for MySQL 4.1.2+).
if ($this->utf){
$this->setUTF();
}
}
/**
* Adds a field or array of field names to the list that are to be quoted.
*
* @param mixed $quoted Field name or array of names.
*
* @return void
*
* @since 11.1
* @deprecated 12.1
*/
public function addQuoted($quoted)
{
// Deprecation warning.
JLog::add('JDatabase::addQuoted() is deprecated.', JLog::WARNING, 'deprecated');
if (is_string($quoted)) {
$this->quoted[] = $quoted;
}
else {
$this->quoted = array_merge($this->quoted, (array) $quoted);
}
$this->hasQuoted = true;
}
/**
* Determines if the connection to the server is active.
*
* @return bool True if connected to the database engine.
*
* @since 11.1
*/
abstract public function connected();
/**
* Method to escape a string for usage in an SQL statement.
*
* @param string The string to be escaped.
* @param bool Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 11.1
*/
abstract public function escape($text, $extra = false);
/**
* Method to fetch a row from the result set cursor as an array.
*
* @param mixed $cursor The optional result set cursor from which to fetch the row.
*
* @return mixed Either the next row from the result set or false if there are no more rows.
*
* @since 11.1
*/
abstract protected function fetchArray($cursor = null);
/**
* Method to fetch a row from the result set cursor as an associative array.
*
* @param mixed $cursor The optional result set cursor from which to fetch the row.
*
* @return mixed Either the next row from the result set or false if there are no more rows.
*
* @since 11.1
*/
abstract protected function fetchAssoc($cursor = null);
/**
* Method to fetch a row from the result set cursor as an object.
*
* @param mixed $cursor The optional result set cursor from which to fetch the row.
* @param string $class The class name to use for the returned row object.
*
* @return mixed Either the next row from the result set or false if there are no more rows.
*
* @since 11.1
*/
abstract protected function fetchObject($cursor = null, $class = 'stdClass');
/**
* Method to free up the memory used for the result set.
*
* @param mixed $cursor The optional result set cursor from which to fetch the row.
*
* @return void
*
* @since 11.1
*/
abstract protected function freeResult($cursor = null);
/**
* Get the number of affected rows for the previous executed SQL statement.
*
* @return integer The number of affected rows.
*
* @since 11.1
*/
abstract public function getAffectedRows();
/**
* Method to get the database collation in use by sampling a text field of a table in the database.
*
* @return mixed The collation in use by the database or boolean false if not supported.
*
* @since 11.1
*/
abstract public function getCollation();
/**
* Method that provides access to the underlying database connection. Useful for when you need to call a
* proprietary method such as postgresql's lo_* methods.
*
* @return resource The underlying database connection resource.
*
* @since 11.1
*/
public function getConnection()
{
return $this->connection;
}
/**
* Get the total number of SQL statements executed by the database driver.
*
* @return integer
*
* @since 11.1
*/
public function getCount()
{
return $this->count;
}
/**
* Returns a PHP date() function compliant date format for the database driver.
*
* @return string The format string.
*
* @since 11.1
*/
public function getDateFormat()
{
return 'Y-m-d H:i:s';
}
/**
* Get the database driver SQL statement log.
*
* @return array SQL statements executed by the database driver.
*
* @since 11.1
*/
public function getLog()
{
return $this->log;
}
/**
* Get the null or zero representation of a timestamp for the database driver.
*
* @return string Null or zero representation of a timestamp.
*
* @since 11.1
*/
public function getNullDate()
{
return $this->nullDate;
}
/**
* Get the number of returned rows for the previous executed SQL statement.
*
* @param resource $cursor An optional database cursor resource to extract the row count from.
*
* @return integer The number of returned rows.
*
* @since 11.1
*/
abstract public function getNumRows($cursor = null);
/**
* Get the common table prefix for the database driver.
*
* @return string The common database table prefix.
*
* @since 11.1
*/
public function getPrefix()
{
return $this->tablePrefix;
}
/**
* Get the current or query, or new JDatabaseQuery object.
*
* @param bool $new False to return the last query set, True to return a new JDatabaseQuery object.
*
* @return mixed The current value of the internal SQL variable or a new JDatabaseQuery object.
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function getQuery($new = false);
/**
* Retrieves field information about the given tables.
*
* @param mixed $tables A table name or a list of table names.
* @param bool $typeOnly True to only return field types.
*
* @return array An array of fields by table.
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function getTableColumns($tables, $typeOnly = true);
/**
* Shows the table CREATE statement that creates the given tables.
*
* @param mixed $tables A table name or a list of table names.
*
* @return array A list of the create SQL for the tables.
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function getTableCreate($tables);
/**
* Retrieves field information about the given tables.
*
* @param mixed $tables A table name or a list of table names.
*
* @return array An array of keys for the table(s).
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function getTableKeys($tables);
/**
* Method to get an array of all tables in the database.
*
* @return array An array of all the tables in the database.
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function getTableList();
/**
* Determine whether or not the database engine supports UTF-8 character encoding.
*
* @return bool True if the database engine supports UTF-8 character encoding.
*
* @since 11.1
*/
public function getUTFSupport()
{
return $this->utf;
}
/**
* Get the version of the database connector
*
* @return string The database connector version.
*
* @since 11.1
*/
abstract public function getVersion();
/**
* Determines if the database engine supports UTF-8 character encoding.
*
* @return boolean True if supported.
*
* @since 11.1
*/
abstract public function hasUTF();
/**
* Method to get the auto-incremented value from the last INSERT statement.
*
* @return integer The value of the auto-increment field from the last inserted row.
*
* @since 11.1
*/
abstract public function insertid();
/**
* Inserts a row into a table based on an object's properties.
*
* @param string $table The name of the database table to insert into.
* @param object $object A reference to an object whose public properties match the table fields.
* @param string $key The name of the primary key. If provided the object property is updated.
*
* @return bool True on success.
*
* @since 11.1
* @throws DatabaseException
*/
public function insertObject($table, & $object, $key = null)
{
// Initialise variables.
$fields = array();
$values = array();
// Create the base insert statement.
$statement = 'INSERT INTO '.$this->quoteName($table).' (%s) VALUES (%s)';
// Iterate over the object variables to build the query fields and values.
foreach (get_object_vars($object) as $k => $v)
{
// Only process non-null scalars.
if (is_array($v) or is_object($v) or $v === null) {
continue;
}
// Ignore any internal fields.
if ($k[0] == '_') {
continue;
}
// Prepare and sanitize the fields and values for the database query.
$fields[] = $this->quoteName($k);
$values[] = $this->isQuoted($k) ? $this->quote($v) : (int) $v;
}
// Set the query and execute the insert.
$this->setQuery(sprintf($statement, implode(',', $fields), implode(',', $values)));
if (!$this->query()) {
return false;
}
// Update the primary key if it exists.
$id = $this->insertid();
if ($key && $id) {
$object->$key = $id;
}
return true;
}
/**
* Method to get the first row of the result set from the database query as an associative array
* of ['field_name' => 'row_value'].
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadAssoc()
{
// Initialise variables.
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get the first row from the result set as an associative array.
if ($array = $this->fetchAssoc($cursor)) {
$ret = $array;
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get an array of the result set rows from the database query where each row is an associative array
* of ['field_name' => 'row_value']. The array of rows can optionally be keyed by a field name, but defaults to
* a sequential numeric array.
*
* NOTE: Chosing to key the result array by a non-unique field name can result in unwanted
* behavior and should be avoided.
*
* @param string $key The name of a field on which to key the result array.
* @param string $column An optional column name. Instead of the whole row, only this column value will be in
* the result array.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadAssocList($key = null, $column = null)
{
// Initialise variables.
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get all of the rows from the result set.
while ($row = $this->fetchAssoc($cursor))
{
$value = ($column) ? (isset($row[$column]) ? $row[$column] : $row) : $row;
if ($key) {
$array[$row[$key]] = $value;
}
else {
$array[] = $value;
}
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Method to get an array of values from the <var>$offset</var> field in each row of the result set from
* the database query.
*
* @param integer $offset The row offset to use to build the result array.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadColumn($offset = 0)
{
// Initialise variables.
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get all of the rows from the result set as arrays.
while ($row = $this->fetchArray($cursor))
{
$array[] = $row[$offset];
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Method to get the next row in the result set from the database query as an object.
*
* @param string $class The class name to use for the returned row object.
*
* @return mixed The result of the query as an array, false if there are no more rows.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadNextObject($class = 'stdClass')
{
static $cursor;
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return $this->errorNum ? null : false;
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchObject($cursor, $class)) {
return $row;
}
// Free up system resources and return.
$this->freeResult($cursor);
$cursor = null;
return false;
}
/**
* Method to get the next row in the result set from the database query as an array.
*
* @return mixed The result of the query as an array, false if there are no more rows.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadNextRow()
{
static $cursor;
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return $this->errorNum ? null : false;
}
// Get the next row from the result set as an object of type $class.
if ($row = $this->fetchArray($cursor)) {
return $row;
}
// Free up system resources and return.
$this->freeResult($cursor);
$cursor = null;
return false;
}
/**
* Method to get the first row of the result set from the database query as an object.
*
* @param string $class The class name to use for the returned row object.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadObject($class = 'stdClass')
{
// Initialise variables.
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get the first row from the result set as an object of type $class.
if ($object = $this->fetchObject($cursor, $class)) {
$ret = $object;
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get an array of the result set rows from the database query where each row is an object. The array
* of objects can optionally be keyed by a field name, but defaults to a sequential numeric array.
*
* NOTE: Chosing to key the result array by a non-unique field name can result in unwanted
* behavior and should be avoided.
*
* @param string $key The name of a field on which to key the result array.
* @param string $class The class name to use for the returned row objects.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadObjectList($key='', $class = 'stdClass')
{
// Initialise variables.
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get all of the rows from the result set as objects of type $class.
while ($row = $this->fetchObject($cursor, $class))
{
if ($key) {
$array[$row->$key] = $row;
}
else {
$array[] = $row;
}
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Method to get the first field of the first row of the result set from the database query.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadResult()
{
// Initialise variables.
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get the first row from the result set as an array.
if ($row = $this->fetchArray($cursor)) {
$ret = $row[0];
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get the first row of the result set from the database query as an array. Columns are indexed
* numerically so the first column in the result set would be accessible via <var>$row[0]</var>, etc.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadRow()
{
// Initialise variables.
$ret = null;
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get the first row from the result set as an array.
if ($row = $this->fetchArray($cursor)) {
$ret = $row;
}
// Free up system resources and return.
$this->freeResult($cursor);
return $ret;
}
/**
* Method to get an array of the result set rows from the database query where each row is an array. The array
* of objects can optionally be keyed by a field offset, but defaults to a sequential numeric array.
*
* NOTE: Chosing to key the result array by a non-unique field can result in unwanted
* behavior and should be avoided.
*
* @param string $key The name of a field on which to key the result array.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
*/
public function loadRowList($key=null)
{
// Initialise variables.
$array = array();
// Execute the query and get the result set cursor.
if (!($cursor = $this->query())) {
return null;
}
// Get all of the rows from the result set as arrays.
while ($row = $this->fetchArray($cursor))
{
if ($key !== null) {
$array[$row[$key]] = $row;
}
else {
$array[] = $row;
}
}
// Free up system resources and return.
$this->freeResult($cursor);
return $array;
}
/**
* Execute the SQL statement.
*
* @return mixed A database cursor resource on success, boolean false on failure.
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function query();
/**
* Method to quote and optionally escape a string to database requirements for insertion into the database.
*
* @param string $text The string to quote.
* @param bool $escape True to escape the string, false to leave it unchanged.
*
* @return string The quoted input string.
*
* @since 11.1
*/
public function quote($text, $escape = true)
{
return '\''.($escape ? $this->escape($text) : $text).'\'';
}
/**
* Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection
* risks and reserved word conflicts.
*
* @param string $name The identifier name to wrap in quotes.
*
* @return string The quote wrapped name.
*
* @since 11.1
*/
public function quoteName($name)
{
// Don't quote names with dot-notation.
if (strpos($name, '.') !== false) {
return $name;
}
else {
$q = $this->nameQuote;
if (strlen($q) == 1) {
return $q.$name.$q;
}
else {
return $q{0}.$name.$q{1};
}
}
}
/**
* This function replaces a string identifier <var>$prefix</var> with the string held is the
* <var>tablePrefix</var> class variable.
*
* @param string $sql The SQL statement to prepare.
* @param string $prefix The common table prefix.
*
* @return string The processed SQL statement.
*
* @since 11.1
*/
protected function replacePrefix($sql, $prefix='#__')
{
// Initialize variables.
$escaped = false;
$startPos = 0;
$quoteChar = '';
$literal = '';
$sql = trim($sql);
$n = strlen($sql);
while ($startPos < $n)
{
$ip = strpos($sql, $prefix, $startPos);
if ($ip === false) {
break;
}
$j = strpos($sql, "'", $startPos);
$k = strpos($sql, '"', $startPos);
if (($k !== false) && (($k < $j) || ($j === false))) {
$quoteChar = '"';
$j = $k;
} else {
$quoteChar = "'";
}
if ($j === false) {
$j = $n;
}
$literal .= str_replace($prefix, $this->tablePrefix, substr($sql, $startPos, $j - $startPos));
$startPos = $j;
$j = $startPos + 1;
if ($j >= $n) {
break;
}
// quote comes first, find end of quote
while (true)
{
$k = strpos($sql, $quoteChar, $j);
$escaped = false;
if ($k === false) {
break;
}
$l = $k - 1;
while ($l >= 0 && $sql{$l} == '\\')
{
$l--;
$escaped = !$escaped;
}
if ($escaped) {
$j = $k+1;
continue;
}
break;
}
if ($k === false) {
// error in the query - no end quote; ignore it
break;
}
$literal .= substr($sql, $startPos, $k - $startPos + 1);
$startPos = $k+1;
}
if ($startPos < $n) {
$literal .= substr($sql, $startPos, $n - $startPos);
}
return $literal;
}
/**
* Select a database for use.
*
* @param string $database The name of the database to select for use.
*
* @return bool True if the database was successfully selected.
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function select($database);
/**
* Sets the database debugging state for the driver.
*
* @param bool $level True to enable debugging.
*
* @return bool The old debugging level.
*
* @since 11.1
*/
public function setDebug($level)
{
$previous = $this->debug;
$this->debug = (bool) $level;
return $previous;
}
/**
* Sets the SQL statement string for later execution.
*
* @param mixed $query The SQL statement to set either as a JDatabaseQuery object or a string.
* @param integer $offset The affected row offset to set.
* @param integer $limit The maximum affected rows to set.
*
* @return JDatabase This object to support method chaining.
*
* @since 11.1
*/
public function setQuery($query, $offset = 0, $limit = 0)
{
$this->sql = $query;
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
/**
* Set the connection to use UTF-8 character encoding.
*
* @return bool True on success.
*
* @since 11.1
*/
abstract public function setUTF();
/**
* Method to commit a transaction.
*
* @return void
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function transactionCommit();
/**
* Method to roll back a transaction.
*
* @return void
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function transactionRollback();
/**
* Method to initialize a transaction.
*
* @return void
*
* @since 11.1
* @throws DatabaseException
*/
abstract public function transactionStart();
/**
* Updates a row in a table based on an object's properties.
*
* @param string $table The name of the database table to update.
* @param object $object A reference to an object whose public properties match the table fields.
* @param string $key The name of the primary key.
* @param bool $nulls True to update null fields or false to ignore them.
*
* @return bool True on success.
*
* @since 11.1
* @throws DatabaseException
*/
public function updateObject($table, & $object, $key, $nulls=false)
{
// Initialise variables.
$fields = array();
$where = '';
// Create the base update statement.
$statement = 'UPDATE '.$this->quoteName($table).' SET %s WHERE %s';
// Iterate over the object variables to build the query fields/value pairs.
foreach (get_object_vars($object) as $k => $v)
{
// Only process scalars that are not internal fields.
if (is_array($v) or is_object($v) or $k[0] == '_') {
continue;
}
// Set the primary key to the WHERE clause instead of a field to update.
if ($k == $key) {
$where = $this->quoteName($k).'='.$this->quote($v);
continue;
}
// Prepare and sanitize the fields and values for the database query.
if ($v === null) {
// If the value is null and we want to update nulls then set it.
if ($nulls) {
$val = 'NULL';
}
// If the value is null and we do not want to update nulls then ignore this field.
else {
continue;
}
}
// The field is not null so we prep it for update.
else {
$val = $this->isQuoted($k) ? $this->quote($v) : (int) $v;
}
// Add the field to be updated.
$fields[] = $this->quoteName($k).'='.$val;
}
// We don't have any fields to update.
if (empty($fields)) {
return true;
}
// Set the query and execute the update.
$this->setQuery(sprintf($statement, implode(",", $fields), $where));
return $this->query();
}
//
// Deprecated methods.
//
/**
* Sets the debug level on or off
*
* @param integer $level 0 to disable debugging and 1 to enable it.
*
* @return void
*
* @since 11.1
* @deprecated 12.1
*/
public function debug($level)
{
// Deprecation warning.
JLog::add('JDatabase::debug() is deprecated, use JDatabase::setDebug() instead.', JLog::NOTICE, 'deprecated');
$this->setDebug(($level == 0) ? false : true);
}
/**
* Diagnostic method to return explain information for a query.
*
* @return string The explain output.
*
* @since 11.1
* @deprecated 12.1
*/
abstract public function explain();
/**
* Gets the error message from the database connection.
*
* @param bool $escaped True to escape the message string for use in JavaScript.
*
* @return string The error message for the most recent query.
*
* @since 11.1
* @deprecated 12.1
*/
public function getErrorMsg($escaped = false)
{
// Deprecation warning.
JLog::add('JDatabase::getErrorMsg() is deprecated, use exception handling instead.', JLog::WARNING, 'deprecated');
if ($escaped) {
return addslashes($this->errorMsg);
} else {
return $this->errorMsg;
}
}
/**
* Gets the error number from the database connection.
*
* @return integer The error number for the most recent query.
*
* @since 11.1
* @deprecated 12.1
*/
public function getErrorNum()
{
// Deprecation warning.
JLog::add('JDatabase::getErrorNum() is deprecated, use exception handling instead.', JLog::WARNING, 'deprecated');
return $this->errorNum;
}
/**
* Method to escape a string for usage in an SQL statement.
*
* @param string The string to be escaped.
* @param bool Optional parameter to provide extra escaping.
*
* @return string The escaped string.
*
* @since 11.1
* @deprecated 11.1
*/
public function getEscaped($text, $extra = false)
{
// Deprecation warning.
JLog::add('JDatabase::getEscaped() is deprecated. Use JDatabase::escape().', JLog::WARNING, 'deprecated');
return $this->escape($text, $extra);
}
/**
* Retrieves field information about the given tables.
*
* @param mixed $tables A table name or a list of table names.
* @param bool $typeOnly True to only return field types.
*
* @return array An array of fields by table.
*
* @since 11.1
* @throws DatabaseException
* @deprecated 11.1
*/
public function getTableFields($tables, $typeOnly = true)
{
// Deprecation warning.
JLog::add('JDatabase::getTableFields() is deprecated. Use JDatabase::getTableColumns().', JLog::WARNING, 'deprecated');
$results = array();
settype($tables, 'array');
foreach ($tables as $table)
{
$results[$table] = $this->getTableColumns($table, $typeOnly);
}
return $results;
}
/**
* Get the total number of SQL statements executed by the database driver.
*
* @return integer
*
* @since 11.1
* @deprecated 12.1
*/
public function getTicker()
{
// Deprecation warning.
JLog::add('JDatabase::getTicker() is deprecated, use JDatabase::getCount() instead.', JLog::NOTICE, 'deprecated');
return $this->count;
}
/**
* Checks if field name needs to be quoted.
*
* @param string $field The field name to be checked.
*
* @return bool
*
* @since 11.1
* @deprecated 12.1
*/
public function isQuoted($field)
{
// Deprecation warning.
JLog::add('JDatabase::isQuoted() is deprecated.', JLog::WARNING, 'deprecated');
if ($this->hasQuoted) {
return in_array($field, $this->quoted);
}
else {
return true;
}
}
/**
* Method to get an array of values from the <var>$offset</var> field in each row of the result set from
* the database query.
*
* @param integer $offset The row offset to use to build the result array.
*
* @return mixed The return value or null if the query failed.
*
* @since 11.1
* @throws DatabaseException
* @deprecated 11.1
*/
public function loadResultArray($offset = 0)
{
// Deprecation warning.
JLog::add('JDatabase::loadResultArray() is deprecated. Use JDatabase::getColumn().', JLog::WARNING, 'deprecated');
return $this->loadColumn($offset);
}
/**
* Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection
* risks and reserved word conflicts.
*
* @param string $name The identifier name to wrap in quotes.
*
* @return string The quote wrapped name.
*
* @since 11.1
* @deprecated 11.1
*/
public function nameQuote($name)
{
// Deprecation warning.
JLog::add('JDatabase::nameQuote() is deprecated. Use JDatabase::quoteName().', JLog::WARNING, 'deprecated');
return $this->quoteName($name);
}
/**
* Execute a query batch.
*
* @return mixed A database resource if successful, false if not.
*
* @since 11.1
* @deprecated 12.1
*/
abstract public function queryBatch($abortOnError = true, $transactionSafe = false);
/**
* Return the most recent error message for the database connector.
*
* @param bool True to display the SQL statement sent to the database as well as the error.
*
* @return string The error message for the most recent query.
*
* @since 11.1
* @deprecated 12.1
*/
public function stderr($showSQL = false)
{
// Deprecation warning.
JLog::add('JDatabase::stderr() is deprecated.', JLog::WARNING, 'deprecated');
if ($this->errorNum != 0) {
return JText::sprintf('JLIB_DATABASE_ERROR_FUNCTION_FAILED', $this->errorNum, $this->errorMsg)
.($showSQL ? "<br />SQL = <pre>$this->sql</pre>" : '');
}
else {
return JText::_('JLIB_DATABASE_FUNCTION_NOERROR');
}
}
}
The same content is in 2 releases, Joomla 1.7.1 to 1.7.2. See them all, or every version of this file.