Class Mage_Core_Model_Resource_Db_Abstract

Abstract resource model class

Mage_Core_Model_Resource_Db_Abstract

Direct known subclasses

Indirect known subclasses

Abstract
Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Core/Model/Resource/Db/Abstract.php

Methods summary
`protected Mage_Core_Model_Resource_Abstract`	# `_init( string $mainTable, string $idFieldName )` Standard resource model initialization Standard resource model initialization Parameters `$mainTable` `string` $mainTable `$idFieldName` `string` $idFieldName Returns `Mage_Core_Model_Resource_Abstract`
`protected Mage_Core_Model_Resource_Abstract`	# `_setResource( string\|array $connections, string\|array\|null $tables = null )` Initialize connections and tables for this resource model If one or both arguments are string, will be used as prefix If $tables is null and $connections is string, $tables will be the same Initialize connections and tables for this resource model If one or both arguments are string, will be used as prefix If $tables is null and $connections is string, $tables will be the same Parameters `$connections` `string\|array` $connections `$tables` `string\|array\|null` $tables Returns `Mage_Core_Model_Resource_Abstract`
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_setMainTable( string $mainTable, string\|null $idFieldName = null )` Set main entity table name and primary key field name If field name is ommited {table_name}_id will be used Set main entity table name and primary key field name If field name is ommited {table_name}_id will be used Parameters `$mainTable` `string` $mainTable `$idFieldName` `string\|null` $idFieldName Returns `Mage_Core_Model_Resource_Db_Abstract`
`public string`	# `getIdFieldName( )` Get primary key field name Get primary key field name Returns `string`
`public string`	# `getMainTable( )` Returns main table name - extracted from "module/table" style and validated by db adapter Returns main table name - extracted from "module/table" style and validated by db adapter Returns `string`
`public string`	# `getTable( string $entityName )` Get table name for the entity, validated by db adapter Get table name for the entity, validated by db adapter Parameters `$entityName` `string` $entityName Returns `string`
`public string`	# `getValueTable( string $entityName, string $valueType )` Retrieve table name for the entity separated value Retrieve table name for the entity separated value Parameters `$entityName` `string` $entityName `$valueType` `string` $valueType Returns `string`
`protected Zend_Db_Adapter_Abstract`	# `_getConnection( string $connectionName )` Get connection by name or type Get connection by name or type Parameters `$connectionName` `string` $connectionName Returns `Zend_Db_Adapter_Abstract`
`protected Varien_Db_Adapter_Interface`	# `_getReadAdapter( )` Retrieve connection for read data Retrieve connection for read data Returns `Varien_Db_Adapter_Interface`
`protected Varien_Db_Adapter_Interface`	# `_getWriteAdapter( )` Retrieve connection for write data Retrieve connection for write data Returns `Varien_Db_Adapter_Interface`
`public Varien_Db_Adapter_Interface`	# `getReadConnection( )` Temporary resolving collection compatibility Temporary resolving collection compatibility Returns `Varien_Db_Adapter_Interface`
`public Mage_Core_Model_Resource_Db_Abstract`	# `load( Mage_Core_Model_Abstract $object, mixed $value, string $field = null )` Load an object Load an object Parameters `$object` `Mage_Core_Model_Abstract` $object `$value` `mixed` $value `$field` `string` $field field to load by (defaults to model id) Returns `Mage_Core_Model_Resource_Db_Abstract`
`protected Zend_Db_Select`	# `_getLoadSelect( string $field, mixed $value, Mage_Core_Model_Abstract $object )` Retrieve select object for load object data Retrieve select object for load object data Parameters `$field` `string` $field `$value` `mixed` $value `$object` `Mage_Core_Model_Abstract` $object Returns `Zend_Db_Select`
`public Mage_Core_Model_Resource_Db_Abstract`	# `save( Mage_Core_Model_Abstract $object )` Save object object data Save object object data Parameters `$object` `Mage_Core_Model_Abstract` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`public Mage_Core_Model_Resource_Db_Abstract`	# `delete( Mage_Core_Model_Abstract $object )` Delete the object Delete the object Parameters `$object` `Varien_Object` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`public Mage_Core_Model_Resource_Db_Abstract`	# `addUniqueField( array\|string $field )` Add unique field restriction Add unique field restriction Parameters `$field` `array\|string` $field Returns `Mage_Core_Model_Resource_Db_Abstract`
`public Mage_Core_Model_Resource_Db_Abstract`	# `resetUniqueField( )` Reset unique fields restrictions Reset unique fields restrictions Returns `Mage_Core_Model_Resource_Db_Abstract`
`public`	# `unserializeFields( Mage_Core_Model_Abstract $object )` Unserialize serializeable object fields Unserialize serializeable object fields Parameters `$object` `Mage_Core_Model_Abstract` $object
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_initUniqueFields( )` Initialize unique fields Initialize unique fields Returns `Mage_Core_Model_Resource_Db_Abstract`
`public array`	# `getUniqueFields( )` Get configuration of all unique fields Get configuration of all unique fields Returns `array`
`protected array`	# `_prepareDataForSave( Mage_Core_Model_Abstract $object )` Prepare data for save Prepare data for save Parameters `$object` `Mage_Core_Model_Abstract` $object Returns `array`
`public boolean`	# `hasDataChanged( Mage_Core_Model_Abstract $object )` Check that model data fields that can be saved has really changed comparing with origData Check that model data fields that can be saved has really changed comparing with origData Parameters `$object` `Mage_Core_Model_Abstract` $object Returns `boolean`
`protected mixed`	# `_prepareValueForSave( mixed $value, string $type )` Prepare value for save Prepare value for save Parameters `$value` `mixed` $value `$type` `string` $type Returns `mixed`
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_checkUnique( Mage_Core_Model_Abstract $object )` Check for unique values existence Check for unique values existence Parameters `$object` `Mage_Core_Model_Abstract` $object Returns `Mage_Core_Model_Resource_Db_Abstract` Throws `Mage_Core_Exception`
`public`	# `afterLoad( Mage_Core_Model_Abstract $object )` After load After load Parameters `$object` `Mage_Core_Model_Abstract` $object
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_afterLoad( Mage_Core_Model_Abstract $object )` Perform actions after object load Perform actions after object load Parameters `$object` `Varien_Object` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_beforeSave( Mage_Core_Model_Abstract $object )` Perform actions before object save Perform actions before object save Parameters `$object` `Varien_Object` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_afterSave( Mage_Core_Model_Abstract $object )` Perform actions after object save Perform actions after object save Parameters `$object` `Varien_Object` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_beforeDelete( Mage_Core_Model_Abstract $object )` Perform actions before object delete Perform actions before object delete Parameters `$object` `Varien_Object` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`protected Mage_Core_Model_Resource_Db_Abstract`	# `_afterDelete( Mage_Core_Model_Abstract $object )` Perform actions after object delete Perform actions after object delete Parameters `$object` `Varien_Object` $object Returns `Mage_Core_Model_Resource_Db_Abstract`
`protected`	# `_serializeFields( Mage_Core_Model_Abstract $object )` Serialize serializeable fields of the object Serialize serializeable fields of the object Parameters `$object` `Mage_Core_Model_Abstract` $object
`public integer\|array`	# `getChecksum( string\|array $table )` Retrieve table checksum Retrieve table checksum Parameters `$table` `string\|array` $table Returns `integer\|array`

Methods inherited from Mage_Core_Model_Resource_Abstract
`__construct(), _construct(), _prepareDataForTable(), _prepareTableValueForSave(), _serializeField(), _unserializeField(), addCommitCallback(), beginTransaction(), commit(), formatDate(), mktime(), rollBack()`

Properties summary
`protected Mage_Core_Model_Resource`	`$_resources`		# Cached resources singleton Cached resources singleton
`protected string`	`$_resourcePrefix`		# Prefix for resources that will be used in this resource model Prefix for resources that will be used in this resource model
`protected array`	`$_connections`	`array()`	# Connections cache for this resource model Connections cache for this resource model
`protected string`	`$_resourceModel`		# Resource model name that contains entities (names of tables) Resource model name that contains entities (names of tables)
`protected array`	`$_tables`	`array()`	# Tables used in this resource model Tables used in this resource model
`protected string`	`$_mainTable`		# Main table name Main table name
`protected string`	`$_idFieldName`		# Main table primary key field name Main table primary key field name
`protected boolean`	`$_isPkAutoIncrement`	`true`	# Primery key auto increment flag Primery key auto increment flag
`protected boolean`	`$_useIsObjectNew`	`false`	# Use is object new method for save of object Use is object new method for save of object
`protected array`	`$_fieldsForUpdate`	`array()`	# Fields List for update in forsedSave Fields List for update in forsedSave
`protected array`	`$_mainTableFields`		# Fields of main table Fields of main table
`protected array`	`$_uniqueFields`	`null`	# Main table unique keys field names could array( array('field' => 'db_field_name1', 'title' => 'Field 1 should be unique') array('field' => 'db_field_name2', 'title' => 'Field 2 should be unique') array( 'field' => array('db_field_name3', 'db_field_name3'), 'title' => 'Field 3 and Field 4 combination should be unique' ) ) or string 'my_field_name' - will be autoconverted to array( array( 'field' => 'my_field_name', 'title' => 'my_field_name' ) ) Main table unique keys field names could array( array('field' => 'db_field_name1', 'title' => 'Field 1 should be unique') array('field' => 'db_field_name2', 'title' => 'Field 2 should be unique') array( 'field' => array('db_field_name3', 'db_field_name3'), 'title' => 'Field 3 and Field 4 combination should be unique' ) ) or string 'my_field_name' - will be autoconverted to array( array( 'field' => 'my_field_name', 'title' => 'my_field_name' ) )
`protected array`	`$_serializableFields`	`array()`	# Serializable fields declaration Structure: array( <field_name> => array( <default_value_for_serialization>, <default_for_unserialization>, <whether_to_unset_empty_when serializing> // optional parameter ), ) Serializable fields declaration Structure: array( <field_name> => array( <default_value_for_serialization>, <default_for_unserialization>, <whether_to_unset_empty_when serializing> // optional parameter ), )

Properties inherited from Mage_Core_Model_Resource_Abstract
`$_commitCallbacks`

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Resource_Db_Abstract

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns