class EasyEmailType in Easy Email 8
Same name and namespace in other branches
- 2.0.x src/Entity/EasyEmailType.php \Drupal\easy_email\Entity\EasyEmailType
Defines the Email template entity.
Plugin annotation
@ConfigEntityType(
id = "easy_email_type",
label = @Translation("Email template"),
label_collection = @Translation("Email Templates"),
handlers = {
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"list_builder" = "Drupal\easy_email\EasyEmailTypeListBuilder",
"form" = {
"add" = "Drupal\easy_email\Form\EasyEmailTypeForm",
"edit" = "Drupal\easy_email\Form\EasyEmailTypeForm",
"delete" = "Drupal\easy_email\Form\EasyEmailTypeDeleteForm"
},
"route_provider" = {
"html" = "Drupal\easy_email\EasyEmailTypeHtmlRouteProvider",
},
},
config_prefix = "easy_email_type",
admin_permission = "administer email types",
bundle_of = "easy_email",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid"
},
config_export = {
"label",
"id",
"key",
"recipient",
"cc",
"bcc",
"fromName",
"fromAddress",
"replyToAddress",
"subject",
"inboxPreview",
"bodyHtml",
"bodyPlain",
"generateBodyPlain",
"attachment",
"saveAttachment",
"attachmentScheme",
"attachmentDirectory"
},
links = {
"canonical" = "/admin/structure/email-templates/templates/{easy_email_type}",
"add-form" = "/admin/structure/email-templates/templates/add",
"edit-form" = "/admin/structure/email-templates/templates/{easy_email_type}/edit",
"delete-form" = "/admin/structure/email-templates/templates/{easy_email_type}/delete",
"collection" = "/admin/structure/email-templates/templates"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\easy_email\Entity\EasyEmailType implements EasyEmailTypeInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of EasyEmailType
File
- src/
Entity/ EasyEmailType.php, line 63
Namespace
Drupal\easy_email\EntityView source
class EasyEmailType extends ConfigEntityBundleBase implements EasyEmailTypeInterface {
/**
* The Email type ID.
*
* @var string
*/
protected $id;
/**
* The Email type label.
*
* @var string
*/
protected $label;
/**
* The Email type key
*
* @var string
*/
protected $key;
/**
* The Email type recipients
*
* @var array
*/
protected $recipient;
/**
* The Email type CC recipients
*
* @var array
*/
protected $cc;
/**
* The Email type BCC recipients
*
* @var array
*/
protected $bcc;
/**
* The Email type From name.
*
* @var string
*/
protected $fromName;
/**
* The Email type From address.
*
* @var string
*/
protected $fromAddress;
/**
* The Email type Reply To address.
*
* @var string
*/
protected $replyToAddress;
/**
* The Email type Subject.
*
* @var string
*/
protected $subject;
/**
* The Email type Inbox Preview.
*
* @var string
*/
protected $inboxPreview;
/**
* The Email type Body HTML text.
*
* @var array
*/
protected $bodyHtml;
/**
* The Email type Body plain text.
*
* @var string
*/
protected $bodyPlain;
/**
* Whether or not to automatically generate the Body plain text from the HTML version
* @var bool
*/
protected $generateBodyPlain;
/**
* The Email type attachments.
*
* @var array
*/
protected $attachment;
/**
* Whether or not to save dynamic attachments to the email entity.
*
* @var bool
*/
protected $saveAttachment;
/**
* @var string
*/
protected $attachmentScheme;
/**
* @var string
*/
protected $attachmentDirectory;
public function __construct(array $values, $entity_type) {
$values += [
'recipient' => [],
'cc' => [],
'bcc' => [],
'bodyHtml' => [],
'attachment' => [],
];
parent::__construct($values, $entity_type);
}
/**
* @return string
*/
public function getId() {
return $this->id;
}
/**
* @param string $id
*
* @return $this
*/
public function setId($id) {
$this->id = $id;
return $this;
}
/**
* @return string
*/
public function getLabel() {
return $this->label;
}
/**
* @param string $label
*
* @return $this
*/
public function setLabel($label) {
$this->label = $label;
return $this;
}
/**
* @return string
*/
public function getKey() {
return $this->key;
}
/**
* @param string $key
*
* @return EasyEmailType
*/
public function setKey($key) {
$this->key = $key;
return $this;
}
/**
* @return array
*/
public function getRecipient() {
return $this->recipient;
}
/**
* @param array $recipient
*
* @return $this
*/
public function setRecipient($recipient) {
$this->recipient = $recipient;
return $this;
}
/**
* @return array
*/
public function getCc() {
return $this->cc;
}
/**
* @param array $cc
*
* @return $this
*/
public function setCc($cc) {
$this->cc = $cc;
return $this;
}
/**
* @return array
*/
public function getBcc() {
return $this->bcc;
}
/**
* @param array $bcc
*
* @return $this
*/
public function setBcc($bcc) {
$this->bcc = $bcc;
return $this;
}
/**
* @return string
*/
public function getFromName() {
return $this->fromName;
}
/**
* @param string $fromName
*
* @return $this
*/
public function setFromName($fromName) {
$this->fromName = $fromName;
return $this;
}
/**
* @return string
*/
public function getFromAddress() {
return $this->fromAddress;
}
/**
* @param string $fromAddress
*
* @return $this
*/
public function setFromAddress($fromAddress) {
$this->fromAddress = $fromAddress;
return $this;
}
/**
* @return string
*/
public function getReplyToAddress() {
return $this->replyToAddress;
}
/**
* @param string $replyToAddress
*
* @return $this
*/
public function setReplyToAddress($replyToAddress) {
$this->replyToAddress = $replyToAddress;
return $this;
}
/**
* @return string
*/
public function getSubject() {
return $this->subject;
}
/**
* @param string $subject
*
* @return $this
*/
public function setSubject($subject) {
$this->subject = $subject;
return $this;
}
/**
* @return string
*/
public function getInboxPreview() {
return $this->inboxPreview;
}
/**
* @param string $inboxPreview
*
* @return $this
*/
public function setInboxPreview($inboxPreview) {
$this->inboxPreview = $inboxPreview;
return $this;
}
/**
* @return array
*/
public function getBodyHtml() {
return $this->bodyHtml;
}
/**
* @param array $bodyHtml
*
* @return $this
*/
public function setBodyHtml($bodyHtml) {
$this->bodyHtml = $bodyHtml;
return $this;
}
/**
* @return string
*/
public function getBodyPlain() {
return $this->bodyPlain;
}
/**
* @param string $bodyPlain
*
* @return $this
*/
public function setBodyPlain($bodyPlain) {
$this->bodyPlain = $bodyPlain;
return $this;
}
/**
* @return bool
*/
public function getGenerateBodyPlain() {
return (bool) $this->generateBodyPlain;
}
/**
* @param bool $generateBodyPlain
*
* @return EasyEmailType
*/
public function setGenerateBodyPlain($generateBodyPlain) {
$this->generateBodyPlain = $generateBodyPlain;
return $this;
}
/**
* @return array
*/
public function getAttachment() {
return $this->attachment;
}
/**
* @param array $attachment
*
* @return $this
*/
public function setAttachment($attachment) {
$this->attachment = $attachment;
return $this;
}
/**
* @return bool
*/
public function getSaveAttachment() {
return (bool) $this->saveAttachment;
}
/**
* @param bool $saveAttachment
*
* @return $this
*/
public function setSaveAttachment($saveAttachment) {
$this->saveAttachment = $saveAttachment;
return $this;
}
/**
* @return string
*/
public function getAttachmentScheme() {
return $this->attachmentScheme;
}
/**
* @param string $attachmentScheme
*
* @return EasyEmailType
*/
public function setAttachmentScheme($attachmentScheme) {
$this->attachmentScheme = $attachmentScheme;
return $this;
}
/**
* @return string
*/
public function getAttachmentDirectory() {
return $this->attachmentDirectory;
}
/**
* @param string $attachmentDirectory
*
* @return EasyEmailType
*/
public function setAttachmentDirectory($attachmentDirectory) {
$this->attachmentDirectory = $attachmentDirectory;
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
ConfigEntityBundleBase:: |
protected | function | Deletes display if a bundle is deleted. | |
ConfigEntityBundleBase:: |
protected | function | Returns view or form displays for this bundle. | |
ConfigEntityBundleBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EasyEmailType:: |
protected | property | The Email type attachments. | |
EasyEmailType:: |
protected | property | ||
EasyEmailType:: |
protected | property | ||
EasyEmailType:: |
protected | property | The Email type BCC recipients | |
EasyEmailType:: |
protected | property | The Email type Body HTML text. | |
EasyEmailType:: |
protected | property | The Email type Body plain text. | |
EasyEmailType:: |
protected | property | The Email type CC recipients | |
EasyEmailType:: |
protected | property | The Email type From address. | |
EasyEmailType:: |
protected | property | The Email type From name. | |
EasyEmailType:: |
protected | property | Whether or not to automatically generate the Body plain text from the HTML version | |
EasyEmailType:: |
protected | property | The Email type ID. | |
EasyEmailType:: |
protected | property | The Email type Inbox Preview. | |
EasyEmailType:: |
protected | property | The Email type key | |
EasyEmailType:: |
protected | property | The Email type label. | |
EasyEmailType:: |
protected | property | The Email type recipients | |
EasyEmailType:: |
protected | property | The Email type Reply To address. | |
EasyEmailType:: |
protected | property | Whether or not to save dynamic attachments to the email entity. | |
EasyEmailType:: |
protected | property | The Email type Subject. | |
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Overrides EasyEmailTypeInterface:: |
|
EasyEmailType:: |
public | function |
Constructs an Entity object. Overrides ConfigEntityBase:: |
|
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |