Class InfoBoxMessage

InfoBoxMessage implements InfoBoxMessageInterface

Package: InfoBox\Entities
Category: System
Located at Services/Core/InfoBox/Entities/InfoBoxMessage.php

Methods summary

`public`	# `__construct( )` InfoBoxMessage constructor. InfoBoxMessage constructor.
`public InfoBoxMessage`	# `setSource( StringType $source )` Sets the message's source. Sets the message's source. Parameters `$source` Source of the message (e.g. 'internal'). Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setSource()`
`public string`	# `getSource( )` Returns the message's source. Returns the message's source. Returns string Source of the message. Implementation of `InfoBoxMessageInterface::getSource()`
`public InfoBoxMessage`	# `setId( IdType $id )` Sets the ID of the message. Sets the ID of the message. Parameters `$id` Identifier of the message. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setId()`
`public integer`	# `getId( )` Returns the ID of the message. Returns the ID of the message. Returns integer ID of the message. Implementation of `InfoBoxMessageInterface::getId()`
`public InfoBoxMessage`	# `setStatus( StringType $status )` Sets the status of the message. Sets the status of the message. Parameters `$status` Status of the message. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setStatus()`
`public string`	# `getStatus( )` Returns the status of the message. Returns the status of the message. Returns string Status of the message. Implementation of `InfoBoxMessageInterface::getStatus()`
`public InfoBoxMessage`	# `setType( StringType $type )` Sets the type of the message. Sets the type of the message. Parameters `$type` Type of the message. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setType()`
`public string`	# `getType( )` Returns the type of the message. Returns the type of the message. Returns string Implementation of `InfoBoxMessageInterface::getType()`
`public InfoBoxMessage`	# `setVisibility( StringType $visibility )` Sets the visibility of the message. Sets the visibility of the message. Parameters `$visibility` Visibility of the message. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setVisibility()`
`public string`	# `getVisibility( )` Returns the visibility of the message. Returns the visibility of the message. Returns string Visibility of the message. Implementation of `InfoBoxMessageInterface::getVisibility()`
`public InfoBoxMessage`	# `setButtonLink( StringType $buttonLink )` Sets the link of the message button. Sets the link of the message button. Parameters `$buttonLink` Link of the message button. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setButtonLink()`
`public string`	# `getButtonLink( )` Returns the link of the message button. Returns the link of the message button. Returns string Link of the message button. Implementation of `InfoBoxMessageInterface::getButtonLink()`
`public InfoBoxMessage`	# `setCustomerId( IdType $customerId )` Sets the customer ID of the message. Sets the customer ID of the message. Parameters `$customerId` Customer ID of the message. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setCustomerId()`
`public integer`	# `getCustomerId( )` Returns the customer ID of the message. Returns the customer ID of the message. Returns integer Implementation of `InfoBoxMessageInterface::getCustomerId()`
`public InfoBoxMessage`	# `setAddedDateTime( DateTime $dateTime )` Sets the message creation date time. Sets the message creation date time. Parameters `$dateTime` Message added date time value. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setAddedDateTime()`
`public DateTime`	# `getAddedDateTime( )` Returns the message creation date time. Returns the message creation date time. Returns DateTime The added date time. Implementation of `InfoBoxMessageInterface::getAddedDateTime()`
`public InfoBoxMessage`	# `setModifiedDateTime( DateTime $dateTime )` Sets the message modification date time. Sets the message modification date time. Parameters `$dateTime` Message modification date time. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setModifiedDateTime()`
`public DateTime`	# `getModifiedDateTime( )` Returns the message modification date time. Returns the message modification date time. Returns DateTime The modified date time. Implementation of `InfoBoxMessageInterface::getModifiedDateTime()`
`public InfoBoxMessage`	# `setHeadLine( StringType $text, LanguageCode $languageCode )` Sets the message headline. Sets the message headline. Parameters `$text` Message headline. `$languageCode` Language code for message headline. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setHeadLine()`
`public string`	# `getHeadLine( LanguageCode $languageCode )` Returns the message headline. Returns the message headline. Parameters `$languageCode` Language code of the message headline. Returns string The message headline. Implementation of `InfoBoxMessageInterface::getHeadLine()`
`public InfoBoxMessage`	# `setMessage( StringType $text, LanguageCode $languageCode )` Sets the message. Sets the message. Parameters `$text` Message. `$languageCode` Language code of the message. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setMessage()`
`public string`	# `getMessage( LanguageCode $languageCode )` Returns the message. Returns the message. Parameters `$languageCode` Language code of the message. Returns string The message. Implementation of `InfoBoxMessageInterface::getMessage()`
`public InfoBoxMessage`	# `setButtonLabel( StringType $text, LanguageCode $languageCode )` Sets the message button label. Sets the message button label. Parameters `$text` Button label text. `$languageCode` Button label text language code. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setButtonLabel()`
`public string`	# `getButtonLabel( LanguageCode $languageCode )` Returns the message button label. Returns the message button label. Parameters `$languageCode` Button label language code. Returns string The message button label. Implementation of `InfoBoxMessageInterface::getButtonLabel()`
`public InfoBoxMessage`	# `setIdentifier( StringType $identifier )` Sets the identifier string of the message Sets the identifier string of the message Parameters `$identifier` Message identifier. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setIdentifier()`
`public string`	# `getIdentifier( )` Returns the message identifier. Returns the message identifier. Returns string Message identifier. Implementation of `InfoBoxMessageInterface::getIdentifier()`
`public InfoBoxMessage`	# `setMessageCollection( KeyValueCollection $messages )` Sets the messages by adding a collection. Sets the messages by adding a collection. Parameters `$messages` Messages. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setMessageCollection()`
`public InfoBoxMessage`	# `setHeadLineCollection( KeyValueCollection $headlines )` Sets the message headlines. Sets the message headlines. Parameters `$headlines` Message headlines. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setHeadLineCollection()`
`public InfoBoxMessage`	# `setButtonLabelCollection( KeyValueCollection $buttonLabels )` Sets the button labels. Sets the button labels. Parameters `$buttonLabels` Message button labels. Returns `InfoBoxMessage` Same instance for method chaining. Implementation of `InfoBoxMessageInterface::setButtonLabelCollection()`
`public EditableKeyValueCollection`	# `getMessageCollection( )` Returns the message collection. Returns the message collection. Returns `EditableKeyValueCollection` Implementation of `InfoBoxMessageInterface::getMessageCollection()`
`public EditableKeyValueCollection`	# `getHeadLineCollection( )` Returns the headline collection. Returns the headline collection. Returns `EditableKeyValueCollection` Implementation of `InfoBoxMessageInterface::getHeadLineCollection()`
`public EditableKeyValueCollection`	# `getButtonLabelCollection( )` Returns the button label collection. Returns the button label collection. Returns `EditableKeyValueCollection` Implementation of `InfoBoxMessageInterface::getButtonLabelCollection()`

Properties summary

`protected string`	`$source` Message source Message source	#
`protected string`	`$id` Message ID Message ID	#
`protected string`	`$identifier` Message identifier Message identifier	#
`protected string`	`$status` Message status Message status	#
`protected string`	`$type` Message type Message type	#
`protected string`	`$visibility` Message visibility Message visibility	#
`protected string`	`$buttonLink` Message button link. Message button link.	#
`protected integer`	`$customerId` Customer ID Customer ID	#
`protected DateTime`	`$addedDateTime` Added date time. Added date time.	#
`protected DateTime`	`$modifiedDateTime` Modified date time. Modified date time.	#
`protected EditableKeyValueCollection`	`$headlines` Message headlines Message headlines	#
`protected EditableKeyValueCollection`	`$messages` Messages Messages	#
`protected EditableKeyValueCollection`	`$buttonLabels` Message button labels. Message button labels.	#

Packages

Classes

Class InfoBoxMessage

Methods summary

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns