AttachmentConfiguration
in package
implements
AttachmentConfigurationInterface
Class AttachmentConfiguration
Important: This value object is not going to check if the attachment file exists in the server because that would cause problems with the service usage (e.g. if an attachment file is missing an exception would halt all the email service operations).
Tags
Interfaces, Classes and Traits
- AttachmentConfigurationInterface
- Interface AttachmentConfigurationInterface
Table of Contents
- ATTACHMENT_CONFIGURATION_NAMESPACE = 'email_attachment'
- PRIVACY_NOTICE_CONTENT_HASH = 'privacy_notice_content_hash'
- TERMS_AND_CONDITIONS_CONTENT_HASH = 'terms_and_conditions_content_hash'
- WITHDRAWAL_FORM_CONTENT_HASH = 'withdrawal_form_content_hash'
- WITHDRAWAL_INFORMATION_CONTENT_HASH = 'withdrawal_information_content_hash'
- $configurationHash : string
- Email attachment configuration hash.
- $configurationKey : string
- Email attachment configuration key.
- $languageCode : string
- Email attachment configuration language code.
- __construct() : mixed
- Constructor
- getConfigurationHash() : string
- Returns the attachment configuration value (hash)
- getConfigurationKey() : string
- Returns the attachment configuration key
- getLanguageCode() : string
- Returns the attachment configuration language code.
- getNamespace() : string
- Returns the namespace of the attachment configuration
- isEqual() : bool
- Checks if the given hash is identical as the property
- setConfigurationHash() : AttachmentConfigurationInterface
- Sets the value of the configuration hash
Constants
ATTACHMENT_CONFIGURATION_NAMESPACE
public
mixed
ATTACHMENT_CONFIGURATION_NAMESPACE
= 'email_attachment'
PRIVACY_NOTICE_CONTENT_HASH
public
mixed
PRIVACY_NOTICE_CONTENT_HASH
= 'privacy_notice_content_hash'
TERMS_AND_CONDITIONS_CONTENT_HASH
public
mixed
TERMS_AND_CONDITIONS_CONTENT_HASH
= 'terms_and_conditions_content_hash'
WITHDRAWAL_FORM_CONTENT_HASH
public
mixed
WITHDRAWAL_FORM_CONTENT_HASH
= 'withdrawal_form_content_hash'
WITHDRAWAL_INFORMATION_CONTENT_HASH
public
mixed
WITHDRAWAL_INFORMATION_CONTENT_HASH
= 'withdrawal_information_content_hash'
Properties
$configurationHash
Email attachment configuration hash.
protected
string
$configurationHash
$configurationKey
Email attachment configuration key.
protected
string
$configurationKey
$languageCode
Email attachment configuration language code.
protected
string
$languageCode
Methods
__construct()
Constructor
public
__construct(string $p_configuration_key, string $p_configuration_hash, string $p_language_code) : mixed
Executes the validation checks for the email attachment.
Parameters
- $p_configuration_key : string
-
E-Mail attachment configuration key.
- $p_configuration_hash : string
-
E-Mail attachment configuration hash.
- $p_language_code : string
-
E-Mail attachment configuration language code.
Tags
Return values
mixed —getConfigurationHash()
Returns the attachment configuration value (hash)
public
getConfigurationHash() : string
Tags
Return values
string —getConfigurationKey()
Returns the attachment configuration key
public
getConfigurationKey() : string
Tags
Return values
string —getLanguageCode()
Returns the attachment configuration language code.
public
getLanguageCode() : string
Tags
Return values
string —getNamespace()
Returns the namespace of the attachment configuration
public
getNamespace() : string
Tags
Return values
string —isEqual()
Checks if the given hash is identical as the property
public
isEqual(string $hash) : bool
Parameters
- $hash : string
Tags
Return values
bool —setConfigurationHash()
Sets the value of the configuration hash
public
setConfigurationHash(string $hash) : AttachmentConfigurationInterface
Parameters
- $hash : string