Docs For Class Mage_Core_Block

Description

Messages block

author: Magento Core Team <[email protected]>

Located in /Core/Block/Messages.php (line 34)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Core_Block_Messages

Direct descendents

Class	Description
Mage_Adminhtml_Block_Messages	Adminhtml messages block

Variable Summary

bool $_escapeMessageFlag

Mage_Core_Model_Message_Collection $_messages

string $_messagesContentWrapperTagName

string $_messagesFirstLevelTagName

string $_messagesSecondLevelTagName

Method Summary

Mage_Core_Block_Messages addError (string $message)

Mage_Core_Block_Messages addMessage (Mage_Core_Model_Message_Abstract $message)

Mage_Core_Block_Messages addMessages (Mage_Core_Model_Message_Collection $messages)

Mage_Core_Block_Messages addNotice (string $message)

Mage_Core_Block_Messages addSuccess (string $message)

Mage_Core_Block_Messages addWarning (string $message)

string getGroupedHtml (string $type)

string getHtml ([string $type = null])

Mage_Core_Model_Message_Collection getMessageCollection ()

array getMessages ([string $type = null])

Mage_Core_Block_Messages setEscapeMessageFlag (bool $flag)

Mage_Core_Block_Messages setMessages (Mage_Core_Model_Message_Collection $messages)

void setMessagesFirstLevelTagName (string $tagName)

void setMessagesSecondLevelTagName (string $tagName)

void _prepareLayout ()

void _toHtml ()

Variables

bool $_escapeMessageFlag = false (line 69)

Flag which require message text escape

access: protected

Mage_Core_Model_Message_Collection $_messages (line 41)

Messages collection

access: protected

string $_messagesContentWrapperTagName = 'span' (line 62)

Store content wrapper html tag name for messages html output

access: protected

string $_messagesFirstLevelTagName = 'ul' (line 48)

Store first level html tag name for messages html output

access: protected

string $_messagesSecondLevelTagName = 'li' (line 55)

Store second level html tag name for messages html output

access: protected

Inherited Variables

Inherited from Mage_Core_Block_Template

Mage_Core_Block_Template::$_baseUrl
Mage_Core_Block_Template::$_jsUrl
Mage_Core_Block_Template::$_showTemplateHints
Mage_Core_Block_Template::$_showTemplateHintsBlocks
Mage_Core_Block_Template::$_template
Mage_Core_Block_Template::$_viewDir
Mage_Core_Block_Template::$_viewVars

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::$_alias
Mage_Core_Block_Abstract::$_anonSuffix
Mage_Core_Block_Abstract::$_childGroups
Mage_Core_Block_Abstract::$_children
Mage_Core_Block_Abstract::$_childrenHtmlCache
Mage_Core_Block_Abstract::$_frameCloseTag
Mage_Core_Block_Abstract::$_frameOpenTag
Mage_Core_Block_Abstract::$_isAnonymous
Mage_Core_Block_Abstract::$_layout
Mage_Core_Block_Abstract::$_messagesBlock
Mage_Core_Block_Abstract::$_nameInLayout
Mage_Core_Block_Abstract::$_parent
Mage_Core_Block_Abstract::$_parentBlock
Mage_Core_Block_Abstract::$_request
Mage_Core_Block_Abstract::$_sortedChildren
Mage_Core_Block_Abstract::$_urlModel

Methods

addError (line 145)

Adding new error message

access: public

Mage_Core_Block_Messages addError (string $message)

string $message

addMessage (line 133)

Adding new message to message collection

access: public

Mage_Core_Block_Messages addMessage (Mage_Core_Model_Message_Abstract $message)

Mage_Core_Model_Message_Abstract $message

addMessages (line 106)

Add messages to display

access: public

Mage_Core_Block_Messages addMessages (Mage_Core_Model_Message_Collection $messages)

Mage_Core_Model_Message_Collection $messages

addNotice (line 169)

Adding new nitice message

access: public

Mage_Core_Block_Messages addNotice (string $message)

string $message

addSuccess (line 181)

Adding new success message

access: public

Mage_Core_Block_Messages addSuccess (string $message)

string $message

addWarning (line 157)

Adding new warning message

access: public

Mage_Core_Block_Messages addWarning (string $message)

string $message

getGroupedHtml (line 222)

Retrieve messages in HTML format grouped by type

access: public

string getGroupedHtml (string $type)

string $type

getHtml (line 204)

Retrieve messages in HTML format

access: public

string getHtml ([string $type = null])

string $type

getMessageCollection (line 119)

Retrieve messages collection

access: public

Mage_Core_Model_Message_Collection getMessageCollection ()

getMessages (line 193)

Retrieve messages array by message type

access: public

array getMessages ([string $type = null])

string $type

setEscapeMessageFlag (line 82)

Set message escape flag

access: public

Mage_Core_Block_Messages setEscapeMessageFlag (bool $flag)

bool $flag

setMessages (line 94)

Set messages collection

access: public

Mage_Core_Block_Messages setMessages (Mage_Core_Model_Message_Collection $messages)

Mage_Core_Model_Message_Collection $messages

setMessagesFirstLevelTagName (line 266)

Set messages first level html tag name for output messages as html

access: public

void setMessagesFirstLevelTagName (string $tagName)

string $tagName

setMessagesSecondLevelTagName (line 276)

Set messages first level html tag name for output messages as html

access: public

void setMessagesSecondLevelTagName (string $tagName)

string $tagName

_prepareLayout (line 71)

access: public

void _prepareLayout ()

Redefinition of:

Mage_Core_Block_Abstract::_prepareLayout(): Preparing global layout

Redefined in descendants as:

_toHtml (line 256)

access: protected

void _toHtml ()

Redefinition of:

Mage_Core_Block_Template::_toHtml(): Render block HTML

Inherited Methods

Inherited From Mage_Core_Block_Template

Mage_Core_Block_Template::assign()
Mage_Core_Block_Template::fetchView()
Mage_Core_Block_Template::getArea()
Mage_Core_Block_Template::getBaseUrl()
Mage_Core_Block_Template::getCacheKeyInfo()
Mage_Core_Block_Template::getDirectOutput()
Mage_Core_Block_Template::getJsUrl()
Mage_Core_Block_Template::getObjectData()
Mage_Core_Block_Template::getShowTemplateHints()
Mage_Core_Block_Template::getTemplate()
Mage_Core_Block_Template::getTemplateFile()
Mage_Core_Block_Template::renderView()
Mage_Core_Block_Template::setScriptPath()
Mage_Core_Block_Template::setTemplate()
Mage_Core_Block_Template::_construct()
Mage_Core_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Abstract

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

Class Constants

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Class Mage_Core_Block_Messages

Inherited Variables

Inherited Methods

Inherited Constants