Docs For Class Mage_Widget_Model_Widget

Description

Widget Instance Model

author: Magento Core Team <[email protected]>

Located in /Widget/Model/Widget/Instance.php (line 34)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Widget_Model_Widget_Instance

Class Constant Summary

ALL_ENTITIES = 'all'

ANCHOR_CATEGORY_LAYOUT_HANDLE = 'catalog_category_layered'

DEFAULT_LAYOUT_HANDLE = 'default'

NOTANCHOR_CATEGORY_LAYOUT_HANDLE = 'catalog_category_default'

PRODUCT_LAYOUT_HANDLE = 'catalog_product_view'

PRODUCT_TYPE_LAYOUT_HANDLE = 'PRODUCT_TYPE_{{TYPE}}'

SINGLE_CATEGORY_LAYOUT_HANDLE = 'CATEGORY_{{ID}}'

SINGLE_PRODUCT_LAYOUT_HANLDE = 'PRODUCT_{{ID}}'

SPECIFIC_ENTITIES = 'specific'

XML_NODE_RELATED_CACHE = 'global/widget/related_cache_types'

Variable Summary

mixed $_layoutHandles

mixed $_specificEntitiesLayoutHandles

Varien_Simplexml_Element $_widgetConfigXml

Method Summary

string generateLayoutUpdateXml (string $blockReference, [ $templatePath = ''], string $position)

string getArea ()

string getPackage ()

string getPackageTheme ()

array getStoreIds ()

string getTheme ()

string getType ()

Varien_Simplexml_Element|null getWidgetConfig ()

array getWidgetParameters ()

array getWidgetsOptionArray ()

array getWidgetSupportedBlocks ()

array getWidgetSupportedTemplatesByBlock (string $blockReference)

array getWidgetTemplates ()

boolean isCompleteToCreate ()

Mage_Widget_Model_Widget_Instance setPackageTheme (string $packageTheme)

Mage_Widget_Model_Widget_Instance setType (string $type)

string|boolean validate ()

void _afterSave ()

void _beforeDelete ()

Mage_Widget_Model_Widget_Instance _beforeSave ()

void _construct ()

Mage_Widget_Model_Widget_Instance _invalidateCache ()

Mage_Widget_Model_Widget_Instance _parsePackageTheme ()

Mage_Widget_Model_Widget_Instance _preparePackageTheme ()

Mage_Widget_Model_Widget_Instance _prepareType ()

Variables

mixed $_layoutHandles = array() (line 49)

access: protected

mixed $_specificEntitiesLayoutHandles = array() (line 51)

access: protected

Varien_Simplexml_Element $_widgetConfigXml = null (line 56)

access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_eventObject
Mage_Core_Model_Abstract::$_eventPrefix
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName

Methods

generateLayoutUpdateXml (line 456)

Generate layout update xml

access: public

string generateLayoutUpdateXml (string $blockReference, [ $templatePath = ''], string $position)

string $blockReference
string $position
$templatePath

getArea (line 249)

Getter.

If not set return default

access: public

string getArea ()

getPackage (line 262)

Getter

access: public

string getPackage ()

getPackageTheme (line 224)

Getter Prepare widget package theme

access: public

string getPackageTheme ()

getStoreIds (line 304)

Getter Explode to array if string setted

access: public

array getStoreIds ()

getTheme (line 275)

Getter

access: public

string getTheme ()

getType (line 185)

Getter Prepare widget type

access: public

string getType ()

getWidgetConfig (line 349)

Load widget XML config and merge with theme widget config

access: public

Varien_Simplexml_Element|null getWidgetConfig ()

getWidgetParameters (line 318)

Getter Unserialize if serialized string setted

access: public

array getWidgetParameters ()

getWidgetsOptionArray (line 331)

Retrieve option arra of widget types

access: public

array getWidgetsOptionArray ()

getWidgetSupportedBlocks (line 405)

Retrieve blocks that widget support

access: public

array getWidgetSupportedBlocks ()

getWidgetSupportedTemplatesByBlock (line 422)

Retrieve widget templates that supported by given block reference

access: public

array getWidgetSupportedTemplatesByBlock (string $blockReference)

string $blockReference

getWidgetTemplates (line 378)

Retrieve widget availabel templates

access: public

array getWidgetTemplates ()

isCompleteToCreate (line 160)

Check if widget instance has required data (other data depends on it)

access: public

boolean isCompleteToCreate ()

setPackageTheme (line 211)

Setter Prepare widget package theme

access: public

Mage_Widget_Model_Widget_Instance setPackageTheme (string $packageTheme)

string $packageTheme

setType (line 172)

Setter Prepare widget type

access: public

Mage_Widget_Model_Widget_Instance setType (string $type)

string $type

validate (line 147)

Validate widget instance data

access: public

string|boolean validate ()

_afterSave (line 508)

Invalidate related cache if instance contain layout updates

access: protected

void _afterSave ()

Redefinition of:

Mage_Core_Model_Abstract::_afterSave(): Processing object after save data

_beforeDelete (line 519)

Invalidate related cache if instance contain layout updates

access: protected

void _beforeDelete ()

Redefinition of:

Mage_Core_Model_Abstract::_beforeDelete(): Processing object before delete data

_beforeSave (line 87)

Processing object before save data

access: protected

Mage_Widget_Model_Widget_Instance _beforeSave ()

Redefinition of:

Mage_Core_Model_Abstract::_beforeSave(): Processing object before save data

_construct (line 61)

Internal Constructor

access: protected

void _construct ()

_invalidateCache (line 495)

Invalidate related cache types

access: protected

Mage_Widget_Model_Widget_Instance _invalidateCache ()

_parsePackageTheme (line 288)

Parse packageTheme and set parsed package and theme

access: protected

Mage_Widget_Model_Widget_Instance _parsePackageTheme ()

_preparePackageTheme (line 235)

Replace '_' to '/', if was set from request(GET request)

access: protected

Mage_Widget_Model_Widget_Instance _preparePackageTheme ()

_prepareType (line 196)

Replace '-' to '/', if was passed from request(GET request)

access: protected

Mage_Widget_Model_Widget_Instance _prepareType ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Class Constants

ALL_ENTITIES = 'all' (line 37)

ANCHOR_CATEGORY_LAYOUT_HANDLE = 'catalog_category_layered' (line 43)

DEFAULT_LAYOUT_HANDLE = 'default' (line 39)

NOTANCHOR_CATEGORY_LAYOUT_HANDLE = 'catalog_category_default' (line 44)

PRODUCT_LAYOUT_HANDLE = 'catalog_product_view' (line 40)

PRODUCT_TYPE_LAYOUT_HANDLE = 'PRODUCT_TYPE_{{TYPE}}' (line 42)

SINGLE_CATEGORY_LAYOUT_HANDLE = 'CATEGORY_{{ID}}' (line 45)

SINGLE_PRODUCT_LAYOUT_HANLDE = 'PRODUCT_{{ID}}' (line 41)

SPECIFIC_ENTITIES = 'specific' (line 36)

XML_NODE_RELATED_CACHE = 'global/widget/related_cache_types' (line 47)

Class Mage_Widget_Model_Widget_Instance

Inherited Variables

Inherited Methods