Mage_Core_Model_Resource Class Reference

List of all members.

Public Member Functions
	getConnection ($name)
	getConnectionTypeInstance ($type)
	getEntity ($model, $entity)
	getTableName ($modelEntity)
	setMappedTableName ($tableName, $mappedName)
	getMappedTableName ($tableName)
	cleanDbRow (&$row)
	createConnection ($name, $type, $config)
	checkDbConnection ()
	getAutoUpdate ()
	setAutoUpdate ($value)
Public Attributes
const	AUTO_UPDATE_CACHE_KEY = 'DB_AUTOUPDATE'
const	AUTO_UPDATE_ONCE = 0
const	AUTO_UPDATE_NEVER = -1
const	AUTO_UPDATE_ALWAYS = 1
Protected Attributes
	$_connectionTypes = array()
	$_connections = array()
	$_entities = array()
	$_mappedTableNames

---

Detailed Description

Resources and connections registry and factory

Definition at line 32 of file Resource.php.

---

Member Function Documentation

checkDbConnection

(

)

Definition at line 198 of file Resource.php.

    {
        if (!$this->getConnection('core_read')) {
            //Mage::app()->getResponse()->setRedirect(Mage::getUrl('install'));
        }
    }

cleanDbRow

(

&$

row

)

Definition at line 177 of file Resource.php.

    {
        if (!empty($row) && is_array($row)) {
            foreach ($row as $key=>&$value) {
                if (is_string($value) && $value==='0000-00-00 00:00:00') {
                    $value = '';
                }
            }
        }
        return $this;
    }

createConnection	(	$	name,
		$	type,
		$	config
	)

Definition at line 189 of file Resource.php.

    {
        if (!isset($this->_connections[$name])) {
            $typeObj = $this->getConnectionTypeInstance($type);
            $this->_connections[$name] = $typeObj->getConnection($config);
        }
        return $this->_connections[$name];
    }

getAutoUpdate

(

)

Definition at line 205 of file Resource.php.

    {
        return self::AUTO_UPDATE_ALWAYS;
        #return Mage::app()->loadCache(self::AUTO_UPDATE_CACHE_KEY);
    }

getConnection

(

$

name

)

Creates a connection to resource whenever needed

Parameters:

string

$name

Returns:

mixed

Definition at line 69 of file Resource.php.

    {
        if (isset($this->_connections[$name])) {
            return $this->_connections[$name];
        }
        $connConfig = Mage::getConfig()->getResourceConnectionConfig($name);

        if (!$connConfig || !$connConfig->is('active', 1)) {
            return false;
        }
        $origName = $connConfig->getParent()->getName();

        if (isset($this->_connections[$origName])) {
            $this->_connections[$name] = $this->_connections[$origName];
            return $this->_connections[$origName];
        }

        $typeInstance = $this->getConnectionTypeInstance((string)$connConfig->type);
        $conn = $typeInstance->getConnection($connConfig);

        $this->_connections[$name] = $conn;
        if ($origName!==$name) {
            $this->_connections[$origName] = $conn;
        }
        return $conn;
    }

getConnectionTypeInstance

(

$

type

)

Get connection type instance

Creates new if doesn't exist

Parameters:

string

$type

Returns:

Mage_Core_Model_Resource_Type_Abstract

Definition at line 104 of file Resource.php.

    {
        if (!isset($this->_connectionTypes[$type])) {
            $config = Mage::getConfig()->getResourceTypeConfig($type);
            $typeClass = $config->getClassName();
            $this->_connectionTypes[$type] = new $typeClass();
        }
        return $this->_connectionTypes[$type];
    }

getEntity	(	$	model,
		$	entity
	)

Get resource entity

Parameters:

	string	$resource
	string	$entity

Returns:

Varien_Simplexml_Config

Definition at line 121 of file Resource.php.

    {
        //return Mage::getConfig()->getNode("global/models/$model/entities/$entity");
        return Mage::getConfig()->getNode()->global->models->{$model}->entities->{$entity};
    }

getMappedTableName

(

$

tableName

)

Definition at line 168 of file Resource.php.

    {
        if (isset($this->_mappedTableNames[$tableName])) {
            return $this->_mappedTableNames[$tableName];
        } else {
            return false;
        }
    }

getTableName

(

$

modelEntity

)

Get resource table name

Parameters:

string

$modelEntity

Returns:

string

Definition at line 133 of file Resource.php.

    {
        $arr = explode('/', $modelEntity);
        if (isset($arr[1])) {
            list($model, $entity) = $arr;
            //$resourceModel = (string)Mage::getConfig()->getNode('global/models/'.$model.'/resourceModel');
            $resourceModel = (string) Mage::getConfig()->getNode()->global->models->{$model}->resourceModel;
            $entityConfig = $this->getEntity($resourceModel, $entity);
            if ($entityConfig) {
                $tableName = (string)$entityConfig->table;
            } else {
                Mage::throwException(Mage::helper('core')->__('Can\'t retrieve entity config: %s', $modelEntity));
            }
        } else {
            $tableName = $modelEntity;
        }
        
        Mage::dispatchEvent('resource_get_tablename', array('resource' => $this, 'model_entity' => $modelEntity, 'table_name' => $tableName));
        $mappedTableName = $this->getMappedTableName($tableName);
        if ($mappedTableName) {
            $tableName = $mappedTableName;
        } else {
            $tablePrefix = (string)Mage::getConfig()->getTablePrefix();
            $tableName = $tablePrefix . $tableName;
        }

        return $tableName;
    }

setAutoUpdate

(

$

value

)

Definition at line 211 of file Resource.php.

    {
        #Mage::app()->saveCache($value, self::AUTO_UPDATE_CACHE_KEY);
        return $this;
    }

setMappedTableName	(	$	tableName,
		$	mappedName
	)

Definition at line 162 of file Resource.php.

    {
        $this->_mappedTableNames[$tableName] = $mappedName;
        return $this;
    }

---

Member Data Documentation

$_connections = array() [protected]

Definition at line 52 of file Resource.php.

$_connectionTypes = array() [protected]

Definition at line 45 of file Resource.php.

$_entities = array() [protected]

Definition at line 59 of file Resource.php.

$_mappedTableNames [protected]

Definition at line 61 of file Resource.php.

const AUTO_UPDATE_ALWAYS = 1

Definition at line 38 of file Resource.php.

const AUTO_UPDATE_CACHE_KEY = 'DB_AUTOUPDATE'

Definition at line 35 of file Resource.php.

const AUTO_UPDATE_NEVER = -1

Definition at line 37 of file Resource.php.

const AUTO_UPDATE_ONCE = 0

Definition at line 36 of file Resource.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Core/Model/Resource.php