Class Mage_Widget_Model_Widget

Description
Description | Methods (details)

Widget model for different purposes

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

Varien_Object
   |
   --Mage_Widget_Model_Widget
Method Summary
Description | Methods (details)
Varien_Object getConfigAsObject (string $type)
null|Varien_Simplexml_Element getConfigAsXml (string $type)
string getWidgetDeclaration (string $type, [array $params = array()], [bool $asIs = true])
array getWidgetsArray ([array $filters = array()])
array getWidgetsRequiredJsFiles ()
Varien_Simplexml_Element getWidgetsXml ([array $filters = array()])
Varien_Simplexml_Config getXmlConfig ()
null|Varien_Simplexml_Element getXmlElementByType (string $type)
string _idEncode (string $string)
int _sortParameters (Varien_Object $a, Varien_Object $b)
boolean _sortWidgets (array $a, array $b)
Methods
Description | Methods (details)
getConfigAsObject (line 91)

Return widget XML configuration as Varien_Object and makes some data preparations

  • access: public
Varien_Object getConfigAsObject (string $type)
  • string $type: Widget type
getConfigAsXml (line 80)

Wrapper for getXmlElementByType method

  • access: public
null|Varien_Simplexml_Element getConfigAsXml (string $type)
  • string $type: Widget type
getWidgetDeclaration (line 219)

Return widget presentation code in WYSIWYG editor

  • return: Widget directive ready to parse
  • access: public
string getWidgetDeclaration (string $type, [array $params = array()], [bool $asIs = true])
  • string $type: Widget Type
  • array $params: Pre-configured Widget Params
  • bool $asIs: Return result as widget directive(true) or as placeholder image(false)
getWidgetsArray (line 191)

Return list of widgets as array

  • access: public
array getWidgetsArray ([array $filters = array()])
  • array $filters: Key-value array of filters for widget node properties
getWidgetsRequiredJsFiles (line 264)

Return list of required JS files to be included on the top of the page before insertion plugin loaded

  • access: public
array getWidgetsRequiredJsFiles ()
getWidgetsXml (line 160)

Return filtered list of widgets as SimpleXml object

  • access: public
Varien_Simplexml_Element getWidgetsXml ([array $filters = array()])
  • array $filters: Key-value array of filters for widget node properties
getXmlConfig (line 41)

Load Widgets XML config from widget.xml files and cache it

  • access: public
Varien_Simplexml_Config getXmlConfig ()
getXmlElementByType (line 65)

Return widget XML config element based on its type

  • access: public
null|Varien_Simplexml_Element getXmlElementByType (string $type)
  • string $type: Widget type
_idEncode (line 283)

Encode string to valid HTML id element, based on base64 encoding

  • access: protected
string _idEncode (string $string)
  • string $string
_sortParameters (line 307)

Widget parameters sort callback

  • access: protected
int _sortParameters (Varien_Object $a, Varien_Object $b)
  • Varien_Object $a
  • Varien_Object $b
_sortWidgets (line 295)

User-defined widgets sorting by Name

  • access: protected
boolean _sortWidgets (array $a, array $b)
  • array $a
  • array $b

Documentation generated on Fri, 11 Feb 2011 17:16:24 +0200 by phpDocumentor 1.4.3