InfoBoxServiceInterface
in
Interface InfoBoxServiceInterface
Tags
Table of Contents
- addMessage() : mixed
- Adds a new info box message.
- deleteMessageById() : mixed
- Deletes a message by its ID.
- deleteMessageByIdentifier() : mixed
- Deletes a message based on its identifier.
- deleteMessageBySource() : mixed
- Deletes a message based on the source.
- getAllMessages() : InfoBoxMessageCollection
- Returns all info box messages.
- reactivateMessages() : mixed
- Reactivates the messages.
- setMessageStatus() : mixed
- Updates a message status.
Methods
addMessage()
Adds a new info box message.
public
addMessage(InfoBoxMessage $message) : mixed
Parameters
- $message : InfoBoxMessage
-
Message to save.
Return values
mixed —deleteMessageById()
Deletes a message by its ID.
public
deleteMessageById(IdType $id) : mixed
Parameters
- $id : IdType
-
Message ID.
Return values
mixed —deleteMessageByIdentifier()
Deletes a message based on its identifier.
public
deleteMessageByIdentifier(StringType $identifier) : mixed
Parameters
- $identifier : StringType
-
Message identifier.
Return values
mixed —deleteMessageBySource()
Deletes a message based on the source.
public
deleteMessageBySource(StringType $source) : mixed
Parameters
- $source : StringType
-
Message source.
Return values
mixed —getAllMessages()
Returns all info box messages.
public
getAllMessages() : InfoBoxMessageCollection
Return values
InfoBoxMessageCollection —reactivateMessages()
Reactivates the messages.
public
reactivateMessages() : mixed
Return values
mixed —setMessageStatus()
Updates a message status.
public
setMessageStatus(IdType $id, StringType $status) : mixed
Parameters
- $id : IdType
-
Message ID.
- $status : StringType
-
Message status.