Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Widget_Adminhtml_Widget_InstanceController
  • Mage_Widget_Adminhtml_WidgetController
  • Mage_Widget_Block_Adminhtml_Widget_Form
  • Mage_Widget_Block_Adminhtml_Widget_Instance
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Block
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Layout
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Chooser_Template
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Form
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Main_Layout
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Properties
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tab_Settings
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Edit_Tabs
  • Mage_Widget_Block_Adminhtml_Widget_Instance_Grid
  • Mage_Widget_Block_Adminhtml_Widget_Options
  • Mage_Widget_Helper_Data
  • Mage_Widget_Model_Mysql4_Widget
  • Mage_Widget_Model_Mysql4_Widget_Instance
  • Mage_Widget_Model_Mysql4_Widget_Instance_Collection
  • Mage_Widget_Model_Observer
  • Mage_Widget_Model_Resource_Widget
  • Mage_Widget_Model_Resource_Widget_Instance
  • Mage_Widget_Model_Resource_Widget_Instance_Collection
  • Mage_Widget_Model_Template_Filter
  • Mage_Widget_Model_Widget
  • Mage_Widget_Model_Widget_Config
  • Mage_Widget_Model_Widget_Instance

Interfaces

  • Mage_Widget_Block_Interface
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Widget_Model_Widget_Instance

Widget Instance Model

Varien_Object
Extended by Mage_Core_Model_Abstract
Extended by Mage_Widget_Model_Widget_Instance
Package: Mage\Widget
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/Widget/Model/Widget/Instance.php
Methods summary
protected
# _construct( )

Internal Constructor

Internal Constructor

protected Varien_Object
# _initOldFieldsMap( )

Init mapping array of short fields to its full names

Init mapping array of short fields to its full names

Returns

Varien_Object
protected Mage_Widget_Model_Widget_Instance
# _beforeSave( )

Processing object before save data

Processing object before save data

Returns

Mage_Widget_Model_Widget_Instance

Overrides

Mage_Core_Model_Abstract::_beforeSave()
public string|boolean
# validate( )

Validate widget instance data

Validate widget instance data

Returns

string|boolean
public boolean
# isCompleteToCreate( )

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

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

Returns

boolean
public Mage_Widget_Model_Widget_Instance
# setType( string $type )

Setter Prepare widget type

Setter Prepare widget type

Parameters

$type
string
$type

Returns

Mage_Widget_Model_Widget_Instance
public string
# getType( )

Getter Prepare widget type

Getter Prepare widget type

Returns

string
protected Mage_Widget_Model_Widget_Instance
# _prepareType( )

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

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

Returns

Mage_Widget_Model_Widget_Instance
public Mage_Widget_Model_Widget_Instance
# setPackageTheme( string $packageTheme )

Setter Prepare widget package theme

Setter Prepare widget package theme

Parameters

$packageTheme
string
$packageTheme

Returns

Mage_Widget_Model_Widget_Instance
public string
# getPackageTheme( )

Getter Prepare widget package theme

Getter Prepare widget package theme

Returns

string
public string
# getArea( )

Getter. If not set return default

Getter. If not set return default

Returns

string
public string
# getPackage( )

Getter

Getter

Returns

string
public string
# getTheme( )

Getter

Getter

Returns

string
protected Mage_Widget_Model_Widget_Instance
# _parsePackageTheme( )

Parse packageTheme and set parsed package and theme

Parse packageTheme and set parsed package and theme

Returns

Mage_Widget_Model_Widget_Instance
public array
# getStoreIds( )

Getter Explode to array if string setted

Getter Explode to array if string setted

Returns

array
public array
# getWidgetParameters( )

Getter Unserialize if serialized string setted

Getter Unserialize if serialized string setted

Returns

array
public array
# getWidgetsOptionArray( )

Retrieve option array of widget types

Retrieve option array of widget types

Returns

array
public Varien_Simplexml_Element|null
# getWidgetConfig( )

Load widget XML config and merge with theme widget config

Load widget XML config and merge with theme widget config

Returns

Varien_Simplexml_Element|null
public array
# getWidgetTemplates( )

Retrieve widget availabel templates

Retrieve widget availabel templates

Returns

array
public array
# getWidgetSupportedBlocks( )

Retrieve blocks that widget support

Retrieve blocks that widget support

Returns

array
public array
# getWidgetSupportedTemplatesByBlock( string $blockReference )

Retrieve widget templates that supported by given block reference

Retrieve widget templates that supported by given block reference

Parameters

$blockReference
string
$blockReference

Returns

array
public string
# generateLayoutUpdateXml( string $blockReference, string $templatePath = '' )

Generate layout update xml

Generate layout update xml

Parameters

$blockReference
string
$blockReference
$templatePath
string
$position

Returns

string
protected Mage_Widget_Model_Widget_Instance
# _invalidateCache( )

Invalidate related cache types

Invalidate related cache types

Returns

Mage_Widget_Model_Widget_Instance
protected Mage_Core_Model_Abstract
# _afterSave( )

Invalidate related cache if instance contain layout updates

Invalidate related cache if instance contain layout updates

Returns

Mage_Core_Model_Abstract

Overrides

Mage_Core_Model_Abstract::_afterSave()
protected Mage_Core_Model_Abstract
# _beforeDelete( )

Invalidate related cache if instance contain layout updates

Invalidate related cache if instance contain layout updates

Returns

Mage_Core_Model_Abstract

Overrides

Mage_Core_Model_Abstract::_beforeDelete()
Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()
Constants summary
string SPECIFIC_ENTITIES 'specific'
#
string ALL_ENTITIES 'all'
#
string DEFAULT_LAYOUT_HANDLE 'default'
#
string PRODUCT_LAYOUT_HANDLE 'catalog_product_view'
#
string SINGLE_PRODUCT_LAYOUT_HANLDE 'PRODUCT_{{ID}}'
#
string PRODUCT_TYPE_LAYOUT_HANDLE 'PRODUCT_TYPE_{{TYPE}}'
#
string ANCHOR_CATEGORY_LAYOUT_HANDLE 'catalog_category_layered'
#
string NOTANCHOR_CATEGORY_LAYOUT_HANDLE 'catalog_category_default'
#
string SINGLE_CATEGORY_LAYOUT_HANDLE 'CATEGORY_{{ID}}'
#
string XML_NODE_RELATED_CACHE 'global/widget/related_cache_types'
#
Properties summary
protected array $_layoutHandles array()
#
protected array $_specificEntitiesLayoutHandles array()
#
protected Varien_Simplexml_Element $_widgetConfigXml null
#
protected string $_eventPrefix 'widget_widget_instance'
#

Prefix of model events names

Prefix of model events names

Properties inherited from Mage_Core_Model_Abstract
$_cacheTag, $_dataSaveAllowed, $_eventObject, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0