Class InfoBoxMessage

Class InfoBoxMessage

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

Methods summary

public __construct( void )

InfoBoxMessage constructor.

public setSource( StringType $source ) : InfoBoxMessage

Sets the message's source.

public getSource( void ) : string

Returns the message's source.

public setId( IdType $id ) : InfoBoxMessage

Sets the ID of the message.

public getId( void ) : integer

Returns the ID of the message.

public setStatus( StringType $status ) : InfoBoxMessage

Sets the status of the message.

public getStatus( void ) : string

Returns the status of the message.

public setType( StringType $type ) : InfoBoxMessage

Sets the type of the message.

public getType( void ) : string

Returns the type of the message.

public setVisibility( StringType $visibility ) : InfoBoxMessage

Sets the visibility of the message.

public getVisibility( void ) : string

Returns the visibility of the message.

public setButtonLink( StringType $buttonLink ) : InfoBoxMessage

Sets the link of the message button.

public getButtonLink( void ) : string

Returns the link of the message button.

public setCustomerId( IdType $customerId ) : InfoBoxMessage

Sets the customer ID of the message.

public getCustomerId( void ) : integer

Returns the customer ID of the message.

public setAddedDateTime( DateTime $dateTime ) : InfoBoxMessage

Sets the message creation date time.

public getAddedDateTime( void ) : DateTime

Returns the message creation date time.

public setModifiedDateTime( DateTime $dateTime ) : InfoBoxMessage

Sets the message modification date time.

public getModifiedDateTime( void ) : DateTime

Returns the message modification date time.

public setHeadLine( StringType $text, LanguageCode $languageCode ) : InfoBoxMessage

Sets the message headline.

public getHeadLine( LanguageCode $languageCode ) : string

Returns the message headline.

public setMessage( StringType $text, LanguageCode $languageCode ) : InfoBoxMessage

Sets the message.

public getMessage( LanguageCode $languageCode ) : string

Returns the message.

public setButtonLabel( StringType $text, LanguageCode $languageCode ) : InfoBoxMessage

Sets the message button label.

public getButtonLabel( LanguageCode $languageCode ) : string

Returns the message button label.

public setIdentifier( StringType $identifier ) : InfoBoxMessage

Sets the identifier string of the message

public getIdentifier( void ) : string

Returns the message identifier.

public setMessageCollection( KeyValueCollection $messages ) : InfoBoxMessage

Sets the messages by adding a collection.

public setHeadLineCollection( KeyValueCollection $headlines ) : InfoBoxMessage

Sets the message headlines.

public setButtonLabelCollection( KeyValueCollection $buttonLabels ) : InfoBoxMessage

Sets the button labels.

public getMessageCollection( void ) : EditableKeyValueCollection

Returns the message collection.

public getHeadLineCollection( void ) : EditableKeyValueCollection

Returns the headline collection.

public getButtonLabelCollection( void ) : EditableKeyValueCollection

Returns the button label collection.

Properties summary

protected $source : string

Message source


		

		

			
			
				
				protected  
				

				
					$id
				

				: string
			

			

				
Message ID

			


			

			

		

		

			
			
				
				protected  
				

				
					$identifier
				

				: string
			

			

				
Message identifier

			


			

			

		

		

			
			
				
				protected  
				

				
					$status
				

				: string
			

			

				
Message status

			


			

			

		

		

			
			
				
				protected  
				

				
					$type
				

				: string
			

			

				
Message type

			


			

			

		

		

			
			
				
				protected  
				

				
					$visibility
				

				: string
			

			

				
Message visibility

			


			

			

		

		
		

			
			
				
				protected  
				

				
					$customerId
				

				: integer
			

			

				
Customer ID

			


			

			

		

		

			
			
				
				protected  
				

				
					$addedDateTime
				

				: DateTime
			

			

				
Added date time.

			


			

			

		

		

			
			
				
				protected  
				

				
					$modifiedDateTime
				

				: DateTime
			

			

				
Modified date time.

			


			

			

		

		

			
			
				
				protected  
				

				
					$headlines
				

				: EditableKeyValueCollection
			

			

				
Message headlines

			


			

			

		

		

			
			
				
				protected  
				

				
					$messages
				

				: EditableKeyValueCollection
			

			

				
Messages

			


			

			

		

		

			
			
				
				protected  
				

				
					$buttonLabels
				

				: EditableKeyValueCollection
			

			

				
Message button labels.