You are here

Home » API reference » Easy Email 2.0.x » EasyEmailType.php

class EasyEmailType in Easy Email 2.0.x

Same name and namespace in other branches
  1. 8 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

Expanded class hierarchy of EasyEmailType

File

src/Entity/EasyEmailType.php, line 63

Namespace

Drupal\easy_email\Entity
View 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

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 14
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
ConfigEntityBundleBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 2
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EasyEmailType::$attachment protected property The Email type attachments.
EasyEmailType::$attachmentDirectory protected property
EasyEmailType::$attachmentScheme protected property
EasyEmailType::$bcc protected property The Email type BCC recipients
EasyEmailType::$bodyHtml protected property The Email type Body HTML text.
EasyEmailType::$bodyPlain protected property The Email type Body plain text.
EasyEmailType::$cc protected property The Email type CC recipients
EasyEmailType::$fromAddress protected property The Email type From address.
EasyEmailType::$fromName protected property The Email type From name.
EasyEmailType::$generateBodyPlain protected property Whether or not to automatically generate the Body plain text from the HTML version
EasyEmailType::$id protected property The Email type ID.
EasyEmailType::$inboxPreview protected property The Email type Inbox Preview.
EasyEmailType::$key protected property The Email type key
EasyEmailType::$label protected property The Email type label.
EasyEmailType::$recipient protected property The Email type recipients
EasyEmailType::$replyToAddress protected property The Email type Reply To address.
EasyEmailType::$saveAttachment protected property Whether or not to save dynamic attachments to the email entity.
EasyEmailType::$subject protected property The Email type Subject.
EasyEmailType::getAttachment public function Overrides EasyEmailTypeInterface::getAttachment
EasyEmailType::getAttachmentDirectory public function Overrides EasyEmailTypeInterface::getAttachmentDirectory
EasyEmailType::getAttachmentScheme public function Overrides EasyEmailTypeInterface::getAttachmentScheme
EasyEmailType::getBcc public function Overrides EasyEmailTypeInterface::getBcc
EasyEmailType::getBodyHtml public function Overrides EasyEmailTypeInterface::getBodyHtml
EasyEmailType::getBodyPlain public function Overrides EasyEmailTypeInterface::getBodyPlain
EasyEmailType::getCc public function Overrides EasyEmailTypeInterface::getCc
EasyEmailType::getFromAddress public function Overrides EasyEmailTypeInterface::getFromAddress
EasyEmailType::getFromName public function Overrides EasyEmailTypeInterface::getFromName
EasyEmailType::getGenerateBodyPlain public function Overrides EasyEmailTypeInterface::getGenerateBodyPlain
EasyEmailType::getId public function Overrides EasyEmailTypeInterface::getId
EasyEmailType::getInboxPreview public function Overrides EasyEmailTypeInterface::getInboxPreview
EasyEmailType::getKey public function Overrides EasyEmailTypeInterface::getKey
EasyEmailType::getLabel public function Overrides EasyEmailTypeInterface::getLabel
EasyEmailType::getRecipient public function Overrides EasyEmailTypeInterface::getRecipient
EasyEmailType::getReplyToAddress public function Overrides EasyEmailTypeInterface::getReplyToAddress
EasyEmailType::getSaveAttachment public function Overrides EasyEmailTypeInterface::getSaveAttachment
EasyEmailType::getSubject public function Overrides EasyEmailTypeInterface::getSubject
EasyEmailType::setAttachment public function Overrides EasyEmailTypeInterface::setAttachment
EasyEmailType::setAttachmentDirectory public function Overrides EasyEmailTypeInterface::setAttachmentDirectory
EasyEmailType::setAttachmentScheme public function Overrides EasyEmailTypeInterface::setAttachmentScheme
EasyEmailType::setBcc public function Overrides EasyEmailTypeInterface::setBcc
EasyEmailType::setBodyHtml public function Overrides EasyEmailTypeInterface::setBodyHtml
EasyEmailType::setBodyPlain public function Overrides EasyEmailTypeInterface::setBodyPlain
EasyEmailType::setCc public function Overrides EasyEmailTypeInterface::setCc
EasyEmailType::setFromAddress public function Overrides EasyEmailTypeInterface::setFromAddress
EasyEmailType::setFromName public function Overrides EasyEmailTypeInterface::setFromName
EasyEmailType::setGenerateBodyPlain public function Overrides EasyEmailTypeInterface::setGenerateBodyPlain
EasyEmailType::setId public function Overrides EasyEmailTypeInterface::setId
EasyEmailType::setInboxPreview public function Overrides EasyEmailTypeInterface::setInboxPreview
EasyEmailType::setKey public function Overrides EasyEmailTypeInterface::setKey
EasyEmailType::setLabel public function Overrides EasyEmailTypeInterface::setLabel
EasyEmailType::setRecipient public function Overrides EasyEmailTypeInterface::setRecipient
EasyEmailType::setReplyToAddress public function Overrides EasyEmailTypeInterface::setReplyToAddress
EasyEmailType::setSaveAttachment public function Overrides EasyEmailTypeInterface::setSaveAttachment
EasyEmailType::setSubject public function Overrides EasyEmailTypeInterface::setSubject
EasyEmailType::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function