Class Mage_Core_Block_Messages

Messages block

Varien_Object

Mage_Core_Block_Abstract

Mage_Core_Block_Template

Mage_Core_Block_Messages

Direct known subclasses

Mage_Adminhtml_Block_Messages

Indirect known subclasses

Mage_Adminhtml_Block_Sales_Order_Create_Messages, Mage_Adminhtml_Block_Sales_Order_View_Messages

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/Block/Messages.php

Methods summary
`public Mage_Core_Block_Abstract`	# `_prepareLayout( )` Preparing global layout Preparing global layout You can redefine this method in child classes for changing layout Returns `Mage_Core_Block_Abstract` Overrides `Mage_Core_Block_Abstract::_prepareLayout()`
`public Mage_Core_Block_Messages`	# `setEscapeMessageFlag( boolean $flag )` Set message escape flag Set message escape flag Parameters `$flag` `boolean` $flag Returns `Mage_Core_Block_Messages`
`public Mage_Core_Block_Messages`	# `setMessages( Mage_Core_Model_Message_Collection $messages )` Set messages collection Set messages collection Parameters `$messages` `Mage_Core_Model_Message_Collection` $messages Returns `Mage_Core_Block_Messages`
`public Mage_Core_Block_Messages`	# `addMessages( Mage_Core_Model_Message_Collection $messages )` Add messages to display Add messages to display Parameters `$messages` `Mage_Core_Model_Message_Collection` $messages Returns `Mage_Core_Block_Messages`
`public Mage_Core_Model_Message_Collection`	# `getMessageCollection( )` Retrieve messages collection Retrieve messages collection Returns `Mage_Core_Model_Message_Collection`
`public Mage_Core_Block_Messages`	# `addMessage( Mage_Core_Model_Message_Abstract $message )` Adding new message to message collection Adding new message to message collection Parameters `$message` `Mage_Core_Model_Message_Abstract` $message Returns `Mage_Core_Block_Messages`
`public Mage_Core_Block_Messages`	# `addError( string $message )` Adding new error message Adding new error message Parameters `$message` `string` $message Returns `Mage_Core_Block_Messages`
`public Mage_Core_Block_Messages`	# `addWarning( string $message )` Adding new warning message Adding new warning message Parameters `$message` `string` $message Returns `Mage_Core_Block_Messages`
`public Mage_Core_Block_Messages`	# `addNotice( string $message )` Adding new nitice message Adding new nitice message Parameters `$message` `string` $message Returns `Mage_Core_Block_Messages`
`public Mage_Core_Block_Messages`	# `addSuccess( string $message )` Adding new success message Adding new success message Parameters `$message` `string` $message Returns `Mage_Core_Block_Messages`
`public array`	# `getMessages( string $type = null )` Retrieve messages array by message type Retrieve messages array by message type Parameters `$type` `string` $type Returns `array`
`public string`	# `getHtml( string $type = null )` Retrieve messages in HTML format Retrieve messages in HTML format Parameters `$type` `string` $type Returns `string`
`public string`	# `getGroupedHtml( )` Retrieve messages in HTML format grouped by type Retrieve messages in HTML format grouped by type Returns `string`
`protected string`	# `_toHtml( )` Render block HTML Render block HTML Returns `string` Overrides `Mage_Core_Block_Template::_toHtml()`
`public`	# `setMessagesFirstLevelTagName( string $tagName )` Set messages first level html tag name for output messages as html Set messages first level html tag name for output messages as html Parameters `$tagName` `string` $tagName
`public`	# `setMessagesSecondLevelTagName( string $tagName )` Set messages first level html tag name for output messages as html Set messages first level html tag name for output messages as html Parameters `$tagName` `string` $tagName
`public array`	# `getCacheKeyInfo( )` Get cache key informative items Get cache key informative items Returns `array` Overrides `Mage_Core_Block_Template::getCacheKeyInfo()`
`public`	# `addStorageType( string $type )` Add used storage type Add used storage type Parameters `$type` `string` $type

Methods inherited from Mage_Core_Block_Template
`_construct(), _getAllowSymlinks(), assign(), fetchView(), getArea(), getBaseUrl(), getDirectOutput(), getJsUrl(), getObjectData(), getShowTemplateHints(), getTemplate(), getTemplateFile(), renderView(), setScriptPath(), setTemplate()`

Methods inherited from Mage_Core_Block_Abstract
__(), _afterCacheUrl(), _afterToHtml(), _beforeCacheUrl(), _beforeChildToHtml(), _beforeToHtml(), _getChildHtml(), _getSidPlaceholder(), _getUrlModel(), _getUrlModelClass(), _loadCache(), _saveCache(), addToChildGroup(), addToParentGroup(), append(), countChildren(), escapeHtml(), escapeUrl(), formatDate(), formatTime(), getAction(), getAnonSuffix(), getBlockAlias(), getBlockHtml(), getCacheKey(), getCacheLifetime(), getCacheTags(), getChild(), getChildChildHtml(), getChildData(), getChildGroup(), getChildHtml(), getHelper(), getIsAnonymous(), getLayout(), getMessagesBlock(), getModuleName(), getNameInLayout(), getParentBlock(), getRequest(), getSkinUrl(), getSortedChildBlocks(), getSortedChildren(), getUrl(), getUrlBase64(), getUrlEncoded(), helper(), insert(), jsQuoteEscape(), setAnonSuffix(), setAttribute(), setBlockAlias(), setChild(), setFrameTags(), setIsAnonymous(), setLayout(), setMessagesBlock(), setNameInLayout(), setParentBlock(), sortChildren(), stripTags(), toHtml(), unsetCallChild(), unsetChild(), unsetChildren()

Constants inherited from Mage_Core_Block_Template
`XML_PATH_DEBUG_TEMPLATE_HINTS, XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS, XML_PATH_TEMPLATE_ALLOW_SYMLINK`

Constants inherited from Mage_Core_Block_Abstract
`CACHE_GROUP`

Properties summary
`protected Mage_Core_Model_Message_Collection`	`$_messages`		# Messages collection Messages collection
`protected string`	`$_messagesFirstLevelTagName`	`'ul'`	# Store first level html tag name for messages html output Store first level html tag name for messages html output
`protected string`	`$_messagesSecondLevelTagName`	`'li'`	# Store second level html tag name for messages html output Store second level html tag name for messages html output
`protected string`	`$_messagesContentWrapperTagName`	`'span'`	# Store content wrapper html tag name for messages html output Store content wrapper html tag name for messages html output
`protected boolean`	`$_escapeMessageFlag`	`false`	# Flag which require message text escape Flag which require message text escape
`protected array`	`$_usedStorageTypes`	`array('core/session')`	# Storage for used types of message storages Storage for used types of message storages

Properties inherited from Mage_Core_Block_Template
`$_allowSymlinks, $_baseUrl, $_jsUrl, $_showTemplateHints, $_showTemplateHintsBlocks, $_template, $_viewDir, $_viewVars`

Properties inherited from Mage_Core_Block_Abstract
`$_alias, $_anonSuffix, $_childGroups, $_children, $_childrenHtmlCache, $_frameCloseTag, $_frameOpenTag, $_isAnonymous, $_layout, $_messagesBlock, $_nameInLayout, $_parent, $_parentBlock, $_request, $_sortInstructions, $_sortedChildren, $_urlModel`

Packages

Classes

Exceptions

Functions

Class Mage_Core_Block_Messages

Direct known subclasses

Indirect known subclasses

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Overrides

Parameters

Parameters

Returns

Overrides

Parameters