AbstractMessage Class Reference

Inheritance diagram for AbstractMessage:

Public Member Functions
	__construct ( $text=null)
	getType ()
	getText ()
	setText ($text)
	setIdentifier ($identifier)
	getIdentifier ()
	setIsSticky ($isSticky=true)
	getIsSticky ()
	toString ()
	setData (array $data=[])
	getData ()

Protected Attributes
	$text
	$identifier
	$isSticky = false
	$data

Additional Inherited Members
Data Fields inherited from MessageInterface
const	DEFAULT_IDENTIFIER = 'default_message_identifier'
const	TYPE_ERROR = 'error'
const	TYPE_WARNING = 'warning'
const	TYPE_NOTICE = 'notice'
const	TYPE_SUCCESS = 'success'

Detailed Description

Abstract message model

@api

Since

100.0.2

Definition at line 14 of file AbstractMessage.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$text = null

)

Parameters

string

$text

Definition at line 39 of file AbstractMessage.php.

      {
        $this->text = $text;
    }

Member Function Documentation

getData()

getData

(

)

Returns message data

Returns

array

Implements MessageInterface.

Definition at line 157 of file AbstractMessage.php.

    {
        return (array)$this->data;
    }

getIdentifier()

getIdentifier

(

)

Getter message identifier

Returns

string

Implements MessageInterface.

Definition at line 91 of file AbstractMessage.php.

    {
        return $this->identifier;
    }

getIsSticky()

getIsSticky

(

)

Getter for flag. Whether message is sticky

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements MessageInterface.

Definition at line 114 of file AbstractMessage.php.

    {
        return $this->isSticky;
    }

getText()

getText

(

)

Getter for text of message

Returns

string

Implements MessageInterface.

Definition at line 57 of file AbstractMessage.php.

    {
        return (string)$this->text;
    }

getType()

getType ( )

abstract

Getter message type

Returns

string

Implements MessageInterface.

setData()

setData

(

array

$data = []

)

Sets message data

Parameters

array

$data

Returns

$this

Exceptions

Implements MessageInterface.

Definition at line 137 of file AbstractMessage.php.

    {
        array_walk_recursive(
            $data,
            function ($element) {
                if (is_object($element) && !$element instanceof \Serializable) {
                    throw new \InvalidArgumentException('Only serializable content is allowed.');
                }
            }
        );

        $this->data = $data;
        return $this;
    }

setIdentifier()

setIdentifier

(

$identifier

)

Setter message identifier

Parameters

string

$identifier

Returns

$this

Implements MessageInterface.

Definition at line 80 of file AbstractMessage.php.

    {
        $this->identifier = $identifier;
        return $this;
    }

setIsSticky()

setIsSticky

(

$isSticky = true

)

Setter for flag. Whether message is sticky

Parameters

bool

$isSticky

Returns

$this

Implements MessageInterface.

Definition at line 102 of file AbstractMessage.php.

    {
        $this->isSticky = $isSticky;
        return $this;
    }

setText()

setText

(

$text

)

Setter message text

Parameters

string

$text

Returns

$this

Implements MessageInterface.

Definition at line 68 of file AbstractMessage.php.

    {
        $this->text = $text;
        return $this;
    }

toString()

toString

(

)

Retrieve message as a string

Returns

string

Implements MessageInterface.

Definition at line 124 of file AbstractMessage.php.

    {
        $out = $this->getType() . ': ' . $this->getIdentifier() . ': ' . $this->getText();
        return $out;
    }

Field Documentation

$data

$data

protected

Definition at line 34 of file AbstractMessage.php.

$identifier

$identifier

protected

Definition at line 24 of file AbstractMessage.php.

$isSticky

$isSticky = false

protected

Definition at line 29 of file AbstractMessage.php.

$text

$text

protected

Definition at line 19 of file AbstractMessage.php.

---

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

• vendor/magento/framework/Message/AbstractMessage.php