Class Mage_Widget_Model_Widget

Widget model for different purposes

Varien_Object

Mage_Widget_Model_Widget

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

Methods summary
`public Varien_Simplexml_Config`	# `getXmlConfig( )` Load Widgets XML config from widget.xml files and cache it Load Widgets XML config from widget.xml files and cache it Returns `Varien_Simplexml_Config`
`public null\|Varien_Simplexml_Element`	# `getXmlElementByType( string $type )` Return widget XML config element based on its type Return widget XML config element based on its type Parameters `$type` `string` $type Widget type Returns `null\|Varien_Simplexml_Element`
`public null\|Varien_Simplexml_Element`	# `getConfigAsXml( string $type )` Wrapper for getXmlElementByType method Wrapper for getXmlElementByType method Parameters `$type` `string` $type Widget type Returns `null\|Varien_Simplexml_Element`
`public Varien_Object`	# `getConfigAsObject( string $type )` Return widget XML configuration as Varien_Object and makes some data preparations Return widget XML configuration as Varien_Object and makes some data preparations Parameters `$type` `string` $type Widget type Returns `Varien_Object`
`public Varien_Simplexml_Element`	# `getWidgetsXml( array $filters = array() )` Return filtered list of widgets as SimpleXml object Return filtered list of widgets as SimpleXml object Parameters `$filters` `array` $filters Key-value array of filters for widget node properties Returns `Varien_Simplexml_Element`
`public array`	# `getWidgetsArray( array $filters = array() )` Return list of widgets as array Return list of widgets as array Parameters `$filters` `array` $filters Key-value array of filters for widget node properties Returns `array`
`public string`	# `getWidgetDeclaration( string $type, array $params = array(), boolean $asIs = true )` Return widget presentation code in WYSIWYG editor Return widget presentation code in WYSIWYG editor Parameters `$type` `string` $type Widget Type `$params` `array` $params Pre-configured Widget Params `$asIs` `boolean` $asIs Return result as widget directive(true) or as placeholder image(false) Returns `string` Widget directive ready to parse
`public array`	# `getWidgetsRequiredJsFiles( )` Return list of required JS files to be included on the top of the page before insertion plugin loaded Return list of required JS files to be included on the top of the page before insertion plugin loaded Returns `array`
`protected string`	# `_idEncode( string $string )` Encode string to valid HTML id element, based on base64 encoding Encode string to valid HTML id element, based on base64 encoding Parameters `$string` `string` $string Returns `string`
`protected boolean`	# `_sortWidgets( array $a, array $b )` User-defined widgets sorting by Name User-defined widgets sorting by Name Parameters `$a` `array` $a `$b` `array` $b Returns `boolean`
`protected integer`	# `_sortParameters( Varien_Object $a, Varien_Object $b )` Widget parameters sort callback Widget parameters sort callback Parameters `$a` `Varien_Object` $a `$b` `Varien_Object` $b Returns `integer`

Packages

Classes

Interfaces

Class Mage_Widget_Model_Widget

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns