Class Mage_Core_Model_Resource_Setup

Resource Setup Model

Direct known subclasses

Mage_Api2_Model_Resource_Setup, Mage_CatalogIndex_Model_Resource_Setup, Mage_Eav_Model_Entity_Setup, Mage_ImportExport_Model_Resource_Setup, Mage_Index_Model_Resource_Setup, Mage_Oauth_Model_Resource_Setup, Mage_Sendfriend_Model_Resource_Setup

Indirect known subclasses

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/Setup.php

Methods summary
`public`	# `__construct( string $resourceName )` Initialize resource configurations, setup connection, etc Initialize resource configurations, setup connection, etc Parameters `$resourceName` `string` $resourceName the setup resource name
`public Varien_Db_Adapter_Interface`	# `getConnection( )` Get connection object Get connection object Returns `Varien_Db_Adapter_Interface`
`public Mage_Core_Model_Resource_Setup`	# `setTable( string $tableName, string $realTableName )` Add table placeholder/table name relation Add table placeholder/table name relation Parameters `$tableName` `string` $tableName `$realTableName` `string` $realTableName Returns `Mage_Core_Model_Resource_Setup`
`public string`	# `getTable( string\|array $tableName )` Get table name (validated by db adapter) by table placeholder Get table name (validated by db adapter) by table placeholder Parameters `$tableName` `string\|array` $tableName Returns `string`
`protected string`	# `_getTableCacheName( string\|array $tableName )` Retrieve table name for cache Retrieve table name for cache Parameters `$tableName` `string\|array` $tableName Returns `string`
`protected Mage_Core_Model_Resource_Resource`	# `_getResource( )` Get core resource resource model Get core resource resource model Returns `Mage_Core_Model_Resource_Resource`
`public static boolean`	# `applyAllUpdates( )` Apply database updates whenever needed Apply database updates whenever needed Returns `boolean`
`public static`	# `applyAllDataUpdates( )` Apply database data updates whenever needed Apply database data updates whenever needed
`public Mage_Core_Model_Resource_Setup`	# `applyDataUpdates( )` Apply data updates to the system after upgrading. Apply data updates to the system after upgrading. Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Core_Model_Resource_Setup`	# `applyUpdates( )` Apply module resource install, upgrade and data scripts Apply module resource install, upgrade and data scripts Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_hookQueries( )` Hooks queries to strengthen backwards compatibility in MySQL. Currently - dynamically updates column types for foreign keys, when their targets were changed during MMDB development. Hooks queries to strengthen backwards compatibility in MySQL. Currently - dynamically updates column types for foreign keys, when their targets were changed during MMDB development. Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_unhookQueries( )` Removes query hook Removes query hook Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Core_Model_Resource_Setup`	# `callbackQueryHook( string & $sql, array & $bind )` Callback function, called on every query adapter processes. Modifies SQL or tables, so that foreign keys will be set successfully Callback function, called on every query adapter processes. Modifies SQL or tables, so that foreign keys will be set successfully Parameters `$sql` `string` $sql `$bind` `array` $bind Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_installData( string $newVersion )` Run data install scripts Run data install scripts Parameters `$newVersion` `string` $newVersion Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_upgradeData( string $oldVersion, string $newVersion )` Run data upgrade scripts Run data upgrade scripts Parameters `$oldVersion` `string` $oldVersion `$newVersion` `string` $newVersion Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_installResourceDb( string $newVersion )` Run resource installation file Run resource installation file Parameters `$newVersion` `string` $newVersion Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_upgradeResourceDb( string $oldVersion, string $newVersion )` Run resource upgrade files from $oldVersion to $newVersion Run resource upgrade files from $oldVersion to $newVersion Parameters `$oldVersion` `string` $oldVersion `$newVersion` `string` $newVersion Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_rollbackResourceDb( string $newVersion, string $oldVersion )` Roll back resource Roll back resource Parameters `$newVersion` `string` $newVersion `$oldVersion` `string` $oldVersion Returns `Mage_Core_Model_Resource_Setup`
`protected Mage_Core_Model_Resource_Setup`	# `_uninstallResourceDb( string $version )` Uninstall resource Uninstall resource Parameters `$version` `string` $version existing resource version Returns `Mage_Core_Model_Resource_Setup`
`protected array`	# `_getAvailableDbFiles( string $actionType, string $fromVersion, string $toVersion )` Retrieve available Database install/upgrade files for current module Retrieve available Database install/upgrade files for current module Parameters `$actionType` `string` $actionType `$fromVersion` `string` $fromVersion `$toVersion` `string` $toVersion Returns `array`
`protected array`	# `_getAvailableDataFiles( string $actionType, string $fromVersion, string $toVersion )` Retrieve available Data install/upgrade files for current module Retrieve available Data install/upgrade files for current module Parameters `$actionType` `string` $actionType `$fromVersion` `string` $fromVersion `$toVersion` `string` $toVersion Returns `array`
`protected Mage_Core_Model_Resource_Setup`	# `_setResourceVersion( string $actionType, string $version )` Save resource version Save resource version Parameters `$actionType` `string` $actionType `$version` `string` $version Returns `Mage_Core_Model_Resource_Setup`
`protected string\|false`	# `_modifyResourceDb( string $actionType, string $fromVersion, string $toVersion )` Run module modification files. Return version of last applied upgrade (false if no upgrades applied) Run module modification files. Return version of last applied upgrade (false if no upgrades applied) Parameters `$actionType` `string` $actionType self::TYPE_* `$fromVersion` `string` $fromVersion `$toVersion` `string` $toVersion Returns `string\|false` Throws `Mage_Core_Exception`
`protected array`	# `_getModifySqlFiles( string $actionType, string $fromVersion, string $toVersion, array $arrFiles )` Get data files for modifications Get data files for modifications Parameters `$actionType` `string` $actionType `$fromVersion` `string` $fromVersion `$toVersion` `string` $toVersion `$arrFiles` `array` $arrFiles Returns `array`
`public mixed\|boolean`	# `getTableRow( string $table, string $idField, string\|integer $id, string $field = null, string $parentField = null, string\|integer $parentId = 0 )` Retrieve row or field from table by id or string and parent id Retrieve row or field from table by id or string and parent id Parameters `$table` `string` $table `$idField` `string` $idField `$id` `string\|integer` $id `$field` `string` $field `$parentField` `string` $parentField `$parentId` `string\|integer` $parentId Returns `mixed\|boolean`
`public Mage_Core_Model_Resource_Setup`	# `deleteTableRow( string $table, string $idField, string\|integer $id, null\|string $parentField = null, integer\|string $parentId = 0 )` Delete table row Delete table row Parameters `$table` `string` $table `$idField` `string` $idField `$id` `string\|integer` $id `$parentField` `null\|string` $parentField `$parentId` `integer\|string` $parentId Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Eav_Model_Entity_Setup`	# `updateTableRow( string $table, string $idField, string\|integer $id, string\|array $field, mixed\|null $value = null, string $parentField = null, string\|integer $parentId = 0 )` Update one or more fields of table row Update one or more fields of table row Parameters `$table` `string` $table `$idField` `string` $idField `$id` `string\|integer` $id `$field` `string\|array` $field `$value` `mixed\|null` $value `$parentField` `string` $parentField `$parentId` `string\|integer` $parentId Returns `Mage_Eav_Model_Entity_Setup`
`public boolean`	# `tableExists( string $table )` Check is table exists Check is table exists Parameters `$table` `string` $table Returns `boolean`
`public Mage_Core_Model_Resource_Setup`	# `setConfigData( string $path, string $value, integer\|string $scope = 'default', integer $scopeId = 0, integer $inherit = 0 )` Save configuration data Save configuration data Parameters `$path` `string` $path `$value` `string` $value `$scope` `integer\|string` $scope `$scopeId` `integer` $scopeId `$inherit` `integer` $inherit Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Core_Model_Resource_Setup`	# `deleteConfigData( string $path, string $scope = null )` Delete config field values Delete config field values Parameters `$path` `string` $path `$scope` `string` $scope (default\|stores\|websites\|config) Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Core_Model_Resource_Setup`	# `run( string $sql )` Run plain SQL query(ies) Run plain SQL query(ies) Parameters `$sql` `string` $sql Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Core_Model_Resource_Setup`	# `startSetup( )` Prepare database before install/upgrade Prepare database before install/upgrade Returns `Mage_Core_Model_Resource_Setup`
`public Mage_Core_Model_Resource_Setup`	# `endSetup( )` Prepare database after install/upgrade Prepare database after install/upgrade Returns `Mage_Core_Model_Resource_Setup`
`public string`	# `getIdxName( string $tableName, array\|string $fields, string $indexType = '' )` Retrieve 32bit UNIQUE HASH for a Table index Retrieve 32bit UNIQUE HASH for a Table index Parameters `$tableName` `string` $tableName `$fields` `array\|string` $fields `$indexType` `string` $indexType Returns `string`
`public string`	# `getFkName( string $priTableName, string $priColumnName, string $refTableName, string $refColumnName )` Retrieve 32bit UNIQUE HASH for a Table foreign key Retrieve 32bit UNIQUE HASH for a Table foreign key Parameters `$priTableName` `string` $priTableName the target table name `$priColumnName` `string` $priColumnName the target table column name `$refTableName` `string` $refTableName the reference table name `$refColumnName` `string` $refColumnName the reference table column name Returns `string`
`public boolean`	# `getCallAfterApplyAllUpdates( )` Check call afterApplyAllUpdates method for setup class Check call afterApplyAllUpdates method for setup class Returns `boolean`
`public Mage_Core_Model_Resource_Setup`	# `afterApplyAllUpdates( )` Run each time after applying of all updates, if setup model setted $_callAfterApplyAllUpdates flag to true Run each time after applying of all updates, if setup model setted $_callAfterApplyAllUpdates flag to true Returns `Mage_Core_Model_Resource_Setup`

Constants summary
`string`	`DEFAULT_SETUP_CONNECTION`	`'core_setup'`	#
`integer`	`VERSION_COMPARE_EQUAL`	`0`	#
`integer`	`VERSION_COMPARE_LOWER`	`-1`	#
`integer`	`VERSION_COMPARE_GREATER`	`1`	#
`string`	`TYPE_DB_INSTALL`	`'install'`	#
`string`	`TYPE_DB_UPGRADE`	`'upgrade'`	#
`string`	`TYPE_DB_ROLLBACK`	`'rollback'`	#
`string`	`TYPE_DB_UNINSTALL`	`'uninstall'`	#
`string`	`TYPE_DATA_INSTALL`	`'data-install'`	#
`string`	`TYPE_DATA_UPGRADE`	`'data-upgrade'`	#

Properties summary
`protected string`	`$_resourceName`		# Setup resource name Setup resource name
`protected Varien_Simplexml_Object`	`$_resourceConfig`		# Setup resource configuration object Setup resource configuration object
`protected Varien_Simplexml_Object`	`$_connectionConfig`		# Connection configuration object Connection configuration object
`protected Varien_Simplexml_Object`	`$_moduleConfig`		# Setup module configuration object Setup module configuration object
`protected boolean`	`$_callAfterApplyAllUpdates`	`false`	# Call afterApplyAllUpdates method flag Call afterApplyAllUpdates method flag
`protected Varien_Db_Adapter_Pdo_Mysql`	`$_conn`		# Setup Connection Setup Connection
`protected array`	`$_tables`	`array()`	# Tables cache array Tables cache array
`protected array`	`$_setupCache`	`array()`	# Tables data cache array Tables data cache array
`protected boolean`	`$_queriesHooked`	`false`	# Flag which shows, that setup has hooked queries from DB adapter Flag which shows, that setup has hooked queries from DB adapter
`protected static boolean`	`$_hadUpdates`		# Flag which allow to detect that some schema update was applied dueting request Flag which allow to detect that some schema update was applied dueting request
`protected static boolean`	`$_schemaUpdatesChecked`		# Flag which allow run data install or upgrade Flag which allow run data install or upgrade

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Resource_Setup

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns