Mage_Core_Model_Message_Abstract Class Reference

Inheritance diagram for Mage_Core_Model_Message_Abstract:

List of all members.

Public Member Functions

__construct ($type, $code='')

getCode ()

getText ()

getType ()

setClass ($class)

setMethod ($method)

toString ()

setIdentifier ($id)

getIdentifier ()

setIsSticky ($isSticky=true)

getIsSticky ()

Protected Attributes

$_type

$_code

$_class

$_method

$_identifier

$_isSticky = false

Detailed Description

Definition at line 34 of file Abstract.php.

Constructor & Destructor Documentation

__construct	(	$	type,
		$	code = `''`
	)

Definition at line 43 of file Abstract.php.

00044     {
00045         $this->_type = $type;
00046         $this->_code = $code;
00047     }

Member Function Documentation

getCode ( )

Definition at line 49 of file Abstract.php.

00050     {
00051         return $this->_code;
00052     }

getIdentifier ( )

Get message identifier

Returns:: string

Definition at line 97 of file Abstract.php.

00098     {
00099         return $this->_identifier;
00100     }

getIsSticky ( )

Get whether message is sticky

Returns:: bool

Definition at line 119 of file Abstract.php.

00120     {
00121         return $this->_isSticky;
00122     }

getText ( )

Definition at line 54 of file Abstract.php.

00055     {
00056         return $this->getCode();
00057     }

getType ( )

Definition at line 59 of file Abstract.php.

00060     {
00061         return $this->_type;
00062     }

setClass ( $ class )

Definition at line 64 of file Abstract.php.

00065     {
00066         $this->_class = $class;
00067     }

setIdentifier ( $ id )

Set message identifier

Parameters:

string

$id

Returns:: Mage_Core_Model_Message_Abstract

Definition at line 86 of file Abstract.php.

00087     {
00088         $this->_identifier = $id;
00089         return $this;
00090     }

setIsSticky ( $ isSticky = true )

Set message sticky status

Parameters:

bool

$isSticky

Returns:: Mage_Core_Model_Message_Abstract

Definition at line 108 of file Abstract.php.

00109     {
00110         $this->_isSticky = $isSticky;
00111         return $this;
00112     }

setMethod ( $ method )

Definition at line 69 of file Abstract.php.

00070     {
00071         $this->_method = $method;
00072     }

toString ( )

Definition at line 74 of file Abstract.php.

00075     {
00076         $out = $this->getType().': '.$this->getText();
00077         return $out;
00078     }

Member Data Documentation

$_class [protected]

Definition at line 38 of file Abstract.php.

$_code [protected]

Definition at line 37 of file Abstract.php.

$_identifier [protected]

Definition at line 40 of file Abstract.php.

$_isSticky = false [protected]

Definition at line 41 of file Abstract.php.

$_method [protected]

Definition at line 39 of file Abstract.php.

$_type [protected]

Definition at line 36 of file Abstract.php.

The documentation for this class was generated from the following file:

app/code/core/Mage/Core/Model/Message/Abstract.php


Public Member Functions
	__construct ($type, $code='')
	getCode ()
	getText ()
	getType ()
	setClass ($class)
	setMethod ($method)
	toString ()
	setIdentifier ($id)
	getIdentifier ()
	setIsSticky ($isSticky=true)
	getIsSticky ()
Protected Attributes
	$_type
	$_code
	$_class
	$_method
	$_identifier
	$_isSticky = false