cakephp2-php8/cake/libs/model/datasources/datasource.php

<?php
/* SVN FILE: $Id$ */

/**
 * DataSource base class
 *
 * Long description for file
 *
 * PHP versions 4 and 5
 *
 * CakePHP :  Rapid Development Framework <http://www.cakephp.org/>
 * Copyright (c) 2006, Cake Software Foundation, Inc.
 *                     1785 E. Sahara Avenue, Suite 490-204
 *                     Las Vegas, Nevada 89104
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @copyright    Copyright (c) 2006, Cake Software Foundation, Inc.
 * @link         http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
 * @package      cake
 * @subpackage   cake.cake.libs.model.datasources
 * @since        CakePHP v 0.10.5.1790
 * @version      $Revision$
 * @modifiedby   $LastChangedBy$
 * @lastmodified $Date$
 * @license      http://www.opensource.org/licenses/mit-license.php The MIT License
 */

/**
 * DataSource base class
 *
 * Long description for file
 *
 * @package    cake
 * @subpackage cake.cake.libs.model.datasources
 * @since      CakePHP v 0.10.5.1790
 *
 */
class DataSource extends Object
{

/**
 * Are we connected to the DataSource?
 *
 * @var boolean
 * @access public
 */
    var $connected = false;

/**
 * Print debug info?
 *
 * @var boolean
 * @access public
 */
    var $debug = false;

/**
 * Print full query debug info?
 *
 * @var boolean
 * @access public
 */
    var $fullDebug = false;

/**
 * Error description of last query
 *
 * @var unknown_type
 * @access public
 */
    var $error = null;

/**
 * String to hold how many rows were affected by the last SQL operation.
 *
 * @var string
 * @access public
 */
    var $affected = null;

/**
 * Number of rows in current resultset
 *
 * @var int
 * @access public
 */
    var $numRows = null;

/**
 * Time the last query took
 *
 * @var int
 * @access public
 */
    var $took = null;

/**
 * Enter description here...
 *
 * @var array
 * @access private
 */
    var $_result = null;

/**
 * Queries count.
 *
 * @var int
 * @access private
 */
    var $_queriesCnt = 0;

/**
 * Total duration of all queries.
 *
 * @var unknown_type
 * @access private
 */
    var $_queriesTime = null;

/**
 * Log of queries executed by this DataSource
 *
 * @var unknown_type
 * @access private
 */
    var $_queriesLog = array();

/**
 * Maximum number of items in query log, to prevent query log taking over
 * too much memory on large amounts of queries -- I we've had problems at
 * >6000 queries on one system.
 *
 * @var int Maximum number of queries in the queries log.
 * @access private
 */
    var $_queriesLogMax = 200;

/**
 * The default configuration of a specific DataSource
 *
 * @var array
 * @access public
 */
    var $_baseConfig = array();

/**
 * Holds references to descriptions loaded by the DataSource
 *
 * @var array
 * @access private
 */
    var $__descriptions = array();

/**
 * A reference to the physical connection of this DataSource
 *
 * @var array
 * @access public
 */
    var $connection = null;

/**
 * The DataSource configuration
 *
 * @var array
 * @access public
 */
    var $config = array();

/**
 * The DataSource configuration key name
 *
 * @var string
 * @access public
 */
    var $configKeyName = null;

/**
 * Whether or not this DataSource is in the middle of a transaction
 *
 * @var boolean
 * @access public
 */
    var $__transactionStarted = false;


/**
 * Constructor.
 *
 */
    function __construct ()
    {
        parent::__construct();
        if(func_num_args() > 0)
        {
          $this->setConfig(func_get_arg(0));
        }
    }

/**
 * Returns true if the DataSource supports the given interface (method)
 *
 * @param string $interface The name of the interface (method)
 * @return boolean True on success
 */
    function isInterfaceSupported ($interface)
    {
      $methods = get_class_methods(get_class($this));
      $methods = strtolower(implode('|', $methods));
      $methods = explode('|', $methods);
      return in_array(strtolower($interface), $methods);
    }

/**
 * Sets the configuration for the DataSource
 *
 * @param array $config The configuration array
 * @return void
 */
    function setConfig ($config)
    {
        if(is_array($this->_baseConfig))
        {
          $this->config = $this->_baseConfig;
          foreach($config as $key => $val)
          {
             $this->config[$key] = $val;
          }
        }
    }

/**
 * Cache the DataSource description
 *
 * @param string $object The name of the object (model) to cache
 * @param mixed $data The description of the model, usually a string or array
 * @return void
 */
    function __cacheDescription ($object, $data = null)
    {
        if (DEBUG > 0)
        {
            $expires = "+10 seconds";
        }
        else
        {
            $expires = "+1 day";
        }

        if ($data !== null)
        {
            $this->__descriptions[$object] = &$data;
            $cache = serialize($data);
        }
        else
        {
            $cache = null;
        }

        $new = cache('models'.DS.low(get_class($this)).'_'.$object, $cache, $expires);
        if($new != null)
        {
            $new = unserialize($new);
        }
        return $new;
    }

/**
 * To-be-overridden in subclasses.
 * @return string
 *
 */
    function conditions ($conditions)
    {
        return $conditions;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $name
 * @return unknown
 */
    function name ($name)
    {
        return $name;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $value
 * @return unknown
 */
    function value ($value)
    {
        return $value;
    }

/**
 * Returns a Model description (metadata) or null if none found.
 *
 * @param Model $model
 * @return mixed
 */
    function describe ($model)
    {
        if (isset($this->__descriptions[$model->table]))
        {
            return $this->__descriptions[$model->table];
        }

        $cache = $this->__cacheDescription($model->table);
        if ($cache !== null)
        {
            $this->__descriptions[$model->table] = &$cache;
            return $cache;
        }
        return null;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $model
 * @param unknown_type $fields
 * @param unknown_type $values
 * @return unknown
 */
    function create (&$model, $fields = null, $values = null)
    {
        return false;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $model
 * @param unknown_type $queryData
 * @return unknown
 */
    function read (&$model, $queryData = array())
    {
        return false;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $model
 * @param unknown_type $fields
 * @param unknown_type $values
 * @return unknown
 */
    function update (&$model, $fields = null, $values = null)
    {
        return false;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $model
 * @param unknown_type $id
 */
    function delete (&$model, $id = null)
    {
        if ($id == null)
        {
            $id = $model->id;
        }
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param mixed $fields
 * @return mixed
 */
    function fields ($fields)
    {
        return $fields;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param Model $model
 * @param unknown_type $fields
 * @return unknown
 */
    function getColumnType (&$model, $fields)
    {
        return false;
    }

/**
 * Formats column data from definition in DBO's $columns array
 *
 * @param string $data The data to be formatted
 * @param array $specs The column definition array
 * @return mixed Data formatted to column specifications
 * @access protected
 */
    function __formatColumnData($data, $specs = array())
    {
        if (isset($specs['formatter']))
        {
            switch($specs['formatter'])
            {
                case 'date':
                    return date($specs['format'], strtotime($data));
                case 'sprintf':
                    return sprintf($specs['format'], $data);
                case 'intval':
                    return intval($data);
                case 'floatval':
                    return floatval($data);
            }
        }
        else
        {
            return $data;
        }
    }

/**
 * Enter description here...
 *
 * @param unknown_type $query
 * @param unknown_type $data
 * @param unknown_type $association
 * @param unknown_type $assocData
 * @param Model $model
 * @param Model $linkModel
 * @param unknown_type $index
 * @return unknown
 */
    function insertQueryData($query, $data, $association, $assocData, &$model, &$linkModel, $index)
    {
        $keys = array('{$__cakeID__$}', '{$__cakeForeignKey__$}');
        foreach($keys as $key)
        {
            $val = null;
            if (strpos($query, $key) !== false)
            {
                switch($key)
                {
                    case '{$__cakeID__$}':
                        if (isset($data[$index][$model->name]))
                        {
                            if(isset($data[$index][$model->name][$model->primaryKey]))
                            {
                                $val = $data[$index][$model->name][$model->primaryKey];
                            }
                            else
                            {
                                $val = '';
                            }
                        }
                    break;
                    case '{$__cakeForeignKey__$}':
                        $foreignKey = Inflector::underscore($linkModel->name).'_id';
                        $val = $data[$index][$model->name][$foreignKey];
                    break;
                }
                $query = r($key, $this->value($val, $model->getColumnType($model->primaryKey)), $query);
            }
        }
        return $query;
    }

/**
 * To-be-overridden in subclasses.
 *
 * @param unknown_type $model
 * @param unknown_type $key
 * @return unknown
 */
    function resolveKey($model, $key)
    {
        return $model->name.$key;
    }

/**
 * Enter description here... The special {n}, as seen in the Model::generateList method, is taken care of here.
 *
 * @param array $data
 * @param mixed $path	As an array, or as a dot-separated string.
 * @return array
 */
    function getFieldValue ($data, $path)
    {
        if (!is_array($path))
        {
            $path = explode('.', $path);
        }
        $tmp = array();

        foreach ($path as $i => $key)
        {
            if (intval($key) > 0 || $key == '0')
            {
                if (isset($data[intval($key)]))
                {
                    $data = $data[intval($key)];
                }
                else
                {
                    return null;
                }
            }
            elseif ($key == '{n}')
            {
                foreach ($data as $j => $val)
                {
                    $tmp[] = DataSource::getFieldValue($val, array_slice($path, $i + 1));
                }
                return $tmp;
            }
            else
            {
                if (isset($data[$key]))
                {
                    $data = $data[$key];
                }
                else
                {
                    return null;
                }
            }
        }
        return $data;
    }
/**
 * To-be-overridden in subclasses.
 *
 */
    function buildSchemaQuery($schema)
    {
        die("Implement in DBO");
    }

/**
 * Closes the current datasource.
 *
 */
    function __destruct ()
    {
        if ($this->connected)
        {
            $this->close();
        }
    }
}

?>