MessageData implements JsonSerializable, Arrayable
FinalYes
Table of Contents
Interfaces
- JsonSerializable
- Arrayable
Constants
- INTEGRITY_STATE_FAIL = 'fail'
- INTEGRITY_STATE_SUCCESS = 'success'
- STATUS_DELIVERED = 'delivered'
- STATUS_ERROR = 'error'
- STATUS_SENT = 'sent'
Methods
- createFromArray() : self
- getAuthor() : string|null
- getChannel() : Channel
- getDescription() : string|null
- Error message / delivery time / etc.
- getError() : Error|null
- getGoskeyOrderId() : string|null
- getIntegrityState() : string|null
- getProviderName() : string|null
- getRecipient() : Signer
- getSesSign() : string|null
- getSesUsername() : string|null
- getStatus() : string
- getSubject() : string|null
- isStatusDelivered() : bool
- isStatusError() : bool
- isStatusSent() : bool
- jsonSerialize() : array<string|int, mixed>
- setAuthor() : MessageData
- setDescription() : self
- setError() : MessageData
- setGoskeyOrderId() : static
- setIntegrityState() : MessageData
- setProviderName() : MessageData
- setSesSign() : MessageData
- setSesUsername() : MessageData
- setStatus() : self
- setSubject() : MessageData
- toArray() : array<string|int, mixed>
Constants
INTEGRITY_STATE_FAIL
public
mixed
INTEGRITY_STATE_FAIL
= 'fail'
INTEGRITY_STATE_SUCCESS
public
mixed
INTEGRITY_STATE_SUCCESS
= 'success'
STATUS_DELIVERED
public
mixed
STATUS_DELIVERED
= 'delivered'
STATUS_ERROR
public
mixed
STATUS_ERROR
= 'error'
STATUS_SENT
public
mixed
STATUS_SENT
= 'sent'
Methods
createFromArray()
public
static createFromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfgetAuthor()
public
getAuthor() : string|null
Return values
string|nullgetChannel()
public
getChannel() : Channel
Return values
ChannelgetDescription()
Error message / delivery time / etc.
public
getDescription() : string|null
Return values
string|nullgetError()
public
getError() : Error|null
Return values
Error|nullgetGoskeyOrderId()
public
getGoskeyOrderId() : string|null
Return values
string|nullgetIntegrityState()
public
getIntegrityState() : string|null
Return values
string|nullgetProviderName()
public
getProviderName() : string|null
Return values
string|nullgetRecipient()
public
getRecipient() : Signer
Return values
SignergetSesSign()
public
getSesSign() : string|null
Return values
string|nullgetSesUsername()
public
getSesUsername() : string|null
Return values
string|nullgetStatus()
public
getStatus() : string
Return values
stringgetSubject()
public
getSubject() : string|null
Return values
string|nullisStatusDelivered()
public
isStatusDelivered() : bool
Return values
boolisStatusError()
public
isStatusError() : bool
Return values
boolisStatusSent()
public
isStatusSent() : bool
Return values
booljsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>setAuthor()
public
setAuthor(string|null $author) : MessageData
Parameters
- $author : string|null
Return values
MessageDatasetDescription()
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
Return values
selfsetError()
public
setError(Error|null $error) : MessageData
Parameters
- $error : Error|null
Return values
MessageDatasetGoskeyOrderId()
public
setGoskeyOrderId(string|null $id) : static
Parameters
- $id : string|null
Return values
staticsetIntegrityState()
public
setIntegrityState(string|null $integrityState) : MessageData
Parameters
- $integrityState : string|null
Return values
MessageDatasetProviderName()
public
setProviderName(string|null $providerName) : MessageData
Parameters
- $providerName : string|null
Return values
MessageDatasetSesSign()
public
setSesSign(string|null $sesSign) : MessageData
Parameters
- $sesSign : string|null
Return values
MessageDatasetSesUsername()
public
setSesUsername(string|null $sesUsername) : MessageData
Parameters
- $sesUsername : string|null
Return values
MessageDatasetStatus()
public
setStatus(string $status) : self
Parameters
- $status : string
Return values
selfsetSubject()
public
setSubject(string|null $subject) : MessageData
Parameters
- $subject : string|null
Return values
MessageDatatoArray()
public
toArray() : array<string|int, mixed>