phpDocumentor

InfoBoxMessage
in package
implements InfoBoxMessageInterface

Class InfoBoxMessage

Tags
category

System

subpackage

Entities

Interfaces, Classes and Traits

InfoBoxMessageInterface
Interface InfoBoxMessageInterface

Table of Contents

$addedDateTime  : DateTime
Added date time.
$buttonLabels  : EditableKeyValueCollection
Message button labels.
$buttonLink  : string
Message button link.
$customerId  : int
Customer ID
$headlines  : EditableKeyValueCollection
Message headlines
$id  : string
Message ID
$identifier  : string
Message identifier
$messages  : EditableKeyValueCollection
Messages
$modifiedDateTime  : DateTime
Modified date time.
$source  : string
Message source
$status  : string
Message status
$type  : string
Message type
$visibility  : string
Message visibility
__construct()  : mixed
InfoBoxMessage constructor.
getAddedDateTime()  : DateTime
Returns the message creation date time.
getButtonLabel()  : string
Returns the message button label.
getButtonLabelCollection()  : EditableKeyValueCollection
Returns the button label collection.
getButtonLink()  : string
Returns the link of the message button.
getCustomerId()  : int
Returns the customer ID of the message.
getHeadLine()  : string
Returns the message headline.
getHeadLineCollection()  : EditableKeyValueCollection
Returns the headline collection.
getId()  : int
Returns the ID of the message.
getIdentifier()  : string
Returns the message identifier.
getMessage()  : string
Returns the message.
getMessageCollection()  : EditableKeyValueCollection
Returns the message collection.
getModifiedDateTime()  : DateTime
Returns the message modification date time.
getSource()  : string
Returns the message's source.
getStatus()  : string
Returns the status of the message.
getType()  : string
Returns the type of the message.
getVisibility()  : string
Returns the visibility of the message.
setAddedDateTime()  : InfoBoxMessage
Sets the message creation date time.
setButtonLabel()  : InfoBoxMessage
Sets the message button label.
setButtonLabelCollection()  : InfoBoxMessage
Sets the button labels.
setButtonLink()  : InfoBoxMessage
Sets the link of the message button.
setCustomerId()  : InfoBoxMessage
Sets the customer ID of the message.
setHeadLine()  : InfoBoxMessage
Sets the message headline.
setHeadLineCollection()  : InfoBoxMessage
Sets the message headlines.
setId()  : InfoBoxMessage
Sets the ID of the message.
setIdentifier()  : InfoBoxMessage
Sets the identifier string of the message
setMessage()  : InfoBoxMessage
Sets the message.
setMessageCollection()  : InfoBoxMessage
Sets the messages by adding a collection.
setModifiedDateTime()  : InfoBoxMessage
Sets the message modification date time.
setSource()  : InfoBoxMessage
Sets the message's source.
setStatus()  : InfoBoxMessage
Sets the status of the message.
setType()  : InfoBoxMessage
Sets the type of the message.
setVisibility()  : InfoBoxMessage
Sets the visibility of the message.

Properties

$addedDateTime

Added date time.

protected DateTime $addedDateTime

$modifiedDateTime

Modified date time.

protected DateTime $modifiedDateTime

Methods

__construct()

InfoBoxMessage constructor.

public __construct() : mixed
Return values
mixed —

getAddedDateTime()

Returns the message creation date time.

public getAddedDateTime() : DateTime
Return values
DateTime —

The added date time.

getButtonLabel()

Returns the message button label.

public getButtonLabel(LanguageCode $languageCode) : string
Parameters
$languageCode : LanguageCode

Button label language code.

Return values
string —

The message button label.

getButtonLink()

Returns the link of the message button.

public getButtonLink() : string
Return values
string —

Link of the message button.

getCustomerId()

Returns the customer ID of the message.

public getCustomerId() : int
Return values
int —

getHeadLine()

Returns the message headline.

public getHeadLine(LanguageCode $languageCode) : string
Parameters
$languageCode : LanguageCode

Language code of the message headline.

Return values
string —

The message headline.

getId()

Returns the ID of the message.

public getId() : int
Return values
int —

ID of the message.

getIdentifier()

Returns the message identifier.

public getIdentifier() : string
Return values
string —

Message identifier.

getMessage()

Returns the message.

public getMessage(LanguageCode $languageCode) : string
Parameters
$languageCode : LanguageCode

Language code of the message.

Return values
string —

The message.

getModifiedDateTime()

Returns the message modification date time.

public getModifiedDateTime() : DateTime
Return values
DateTime —

The modified date time.

getSource()

Returns the message's source.

public getSource() : string
Return values
string —

Source of the message.

getStatus()

Returns the status of the message.

public getStatus() : string
Return values
string —

Status of the message.

getType()

Returns the type of the message.

public getType() : string
Return values
string —

getVisibility()

Returns the visibility of the message.

public getVisibility() : string
Return values
string —

Visibility of the message.

setAddedDateTime()

Sets the message creation date time.

public setAddedDateTime(DateTime $dateTime) : InfoBoxMessage
Parameters
$dateTime : DateTime

Message added date time value.

Return values
InfoBoxMessage —

Same instance for method chaining.

setModifiedDateTime()

Sets the message modification date time.

public setModifiedDateTime(DateTime $dateTime) : InfoBoxMessage
Parameters
$dateTime : DateTime

Message modification date time.

Return values
InfoBoxMessage —

Same instance for method chaining.

Search results