You are here

Home » API reference » Commerce Email 8 » Email.php

class Email in Commerce Email 8

Defines the email entity class.

Plugin annotation


@ConfigEntityType(
  id = "commerce_email",
  label = @Translation("Email"),
  label_collection = @Translation("Emails"),
  label_singular = @Translation("email"),
  label_plural = @Translation("emails"),
  label_count = @PluralTranslation(
    singular = "@count email",
    plural = "@count emails",
  ),
  handlers = {
    "access" = "Drupal\Core\Entity\EntityAccessControlHandler",
    "form" = {
      "add" = "Drupal\commerce_email\Form\EmailForm",
      "duplicate" = "Drupal\commerce_email\Form\EmailForm",
      "edit" = "Drupal\commerce_email\Form\EmailForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm",
    },
    "local_task_provider" = {
      "default" = "Drupal\entity\Menu\DefaultEntityLocalTaskProvider",
    },
    "route_provider" = {
      "default" = "Drupal\entity\Routing\DefaultHtmlRouteProvider",
    },
    "list_builder" = "Drupal\commerce_email\EmailListBuilder",
  },
  admin_permission = "administer commerce_email",
  config_prefix = "commerce_email",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  config_export = {
    "id",
    "label",
    "event",
    "targetEntityType",
    "from",
    "to",
    "cc",
    "bcc",
    "subject",
    "body",
    "conditions",
    "conditionOperator",
  },
  links = {
    "add-form" = "/admin/commerce/config/emails/add",
    "edit-form" = "/admin/commerce/config/emails/{commerce_email}/edit",
    "duplicate-form" = "/admin/commerce/config/emails/{commerce_email}/duplicate",
    "delete-form" = "/admin/commerce/config/emails/{commerce_email}/delete",
    "collection" = "/admin/commerce/config/emails"
  }
)

Hierarchy

Expanded class hierarchy of Email

2 string references to 'Email'
commerce_email.schema.yml in config/schema/commerce_email.schema.yml
config/schema/commerce_email.schema.yml
EmailListBuilder::buildHeader in src/EmailListBuilder.php
Builds the header row for the entity listing.

File

src/Entity/Email.php, line 70

Namespace

Drupal\commerce_email\Entity
View source 
class Email extends ConfigEntityBase implements EmailInterface {

  /**
   * The email ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The email label.
   *
   * @var string
   */
  protected $label;

  /**
   * The email event.
   *
   * @var string
   */
  protected $event;

  /**
   * The target entity type ID.
   *
   * @var string
   */
  protected $targetEntityType;

  /**
   * The "from" address.
   *
   * @var string
   */
  protected $from;

  /**
   * The "to" address.
   *
   * @var string
   */
  protected $to;

  /**
   * The "CC" address.
   *
   * @var string
   */
  protected $cc;

  /**
   * The "BCC" address.
   *
   * @var string
   */
  protected $bcc;

  /**
   * The subject.
   *
   * @var string
   */
  protected $subject;

  /**
   * The body.
   *
   * @var string
   */
  protected $body;

  /**
   * The conditions.
   *
   * @var array
   */
  protected $conditions = [];

  /**
   * The condition operator.
   *
   * @var string
   */
  protected $conditionOperator = 'AND';

  /**
   * {@inheritdoc}
   */
  public function getEvent() {
    if ($this->event) {

      /** @var \Drupal\Core\Plugin\DefaultPluginManager $email_event_manager */
      $email_event_manager = \Drupal::service('plugin.manager.commerce_email_event');
      return $email_event_manager
        ->createInstance($this->event);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getEventId() {
    return $this->event;
  }

  /**
   * {@inheritdoc}
   */
  public function setEventId($event_id) {
    $this->event = $event_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetEntityTypeId() {
    return $this->targetEntityType;
  }

  /**
   * {@inheritdoc}
   */
  public function setTargetEntityTypeId($entity_type_id) {
    $this->targetEntityType = $entity_type_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getFrom() {
    return $this->from;
  }

  /**
   * {@inheritdoc}
   */
  public function setFrom($from) {
    $this->from = $from;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getTo() {
    return $this->to;
  }

  /**
   * {@inheritdoc}
   */
  public function setTo($to) {
    $this->to = $to;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCc() {
    return $this->cc;
  }

  /**
   * {@inheritdoc}
   */
  public function setCc($cc) {
    $this->cc = $cc;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBcc() {
    return $this->cc;
  }

  /**
   * {@inheritdoc}
   */
  public function setBcc($bcc) {
    $this->bcc = $bcc;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSubject() {
    return $this->subject;
  }

  /**
   * {@inheritdoc}
   */
  public function setSubject($subject) {
    $this->subject = $subject;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBody() {
    return $this->body;
  }

  /**
   * {@inheritdoc}
   */
  public function setBody($body) {
    return $this->body = $body;
  }

  /**
   * {@inheritdoc}
   */
  public function getConditions() {
    $plugin_manager = \Drupal::service('plugin.manager.commerce_condition');
    $conditions = [];
    foreach ($this->conditions as $condition) {
      $condition = $plugin_manager
        ->createInstance($condition['plugin'], $condition['configuration']);
      if ($condition instanceof ParentEntityAwareInterface) {
        $condition
          ->setParentEntity($this);
      }
      $conditions[] = $condition;
    }
    return $conditions;
  }

  /**
   * {@inheritdoc}
   */
  public function getConditionOperator() {
    return $this->conditionOperator;
  }

  /**
   * {@inheritdoc}
   */
  public function setConditionOperator($condition_operator) {
    $this->conditionOperator = $condition_operator;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function applies(ContentEntityInterface $entity) {
    $conditions = $this
      ->getConditions();
    if (!$conditions) {

      // Emails without conditions always apply.
      return TRUE;
    }
    $condition_group = new ConditionGroup($conditions, $this
      ->getConditionOperator());
    return $condition_group
      ->evaluate($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);

    // Populate the target entity type ID from the event.
    if ($this->event && !$this->targetEntityType) {
      $this->targetEntityType = $this
        ->getEvent()
        ->getEntityTypeId();
    }
  }

}

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 Information maintained by Drupal core about configuration.
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 13
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::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
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::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
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
Email::$bcc protected property The "BCC" address.
Email::$body protected property The body.
Email::$cc protected property The "CC" address.
Email::$conditionOperator protected property The condition operator.
Email::$conditions protected property The conditions.
Email::$event protected property The email event.
Email::$from protected property The "from" address.
Email::$id protected property The email ID.
Email::$label protected property The email label.
Email::$subject protected property The subject.
Email::$targetEntityType protected property The target entity type ID.
Email::$to protected property The "to" address.
Email::applies public function Checks whether the email applies to the given entity. Overrides EmailInterface::applies
Email::getBcc public function Gets the "BCC" address. Overrides EmailInterface::getBcc
Email::getBody public function Gets the body. Overrides EmailInterface::getBody
Email::getCc public function Gets the "CC" address. Overrides EmailInterface::getCc
Email::getConditionOperator public function Gets the email condition operator. Overrides EmailInterface::getConditionOperator
Email::getConditions public function Gets the email conditions. Overrides EmailInterface::getConditions
Email::getEvent public function Gets the email event. Overrides EmailInterface::getEvent
Email::getEventId public function Gets the email event ID. Overrides EmailInterface::getEventId
Email::getFrom public function Gets the "from" address. Overrides EmailInterface::getFrom
Email::getSubject public function Gets the subject. Overrides EmailInterface::getSubject
Email::getTargetEntityTypeId public function Gets the target entity type ID. Overrides EmailInterface::getTargetEntityTypeId
Email::getTo public function Gets the "to" address. Overrides EmailInterface::getTo
Email::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
Email::setBcc public function Sets the "BCC" address. Overrides EmailInterface::setBcc
Email::setBody public function Sets the body. Overrides EmailInterface::setBody
Email::setCc public function Sets the "CC" address. Overrides EmailInterface::setCc
Email::setConditionOperator public function Sets the email condition operator. Overrides EmailInterface::setConditionOperator
Email::setEventId public function Sets the email event ID. Overrides EmailInterface::setEventId
Email::setFrom public function Sets the "from" address. Overrides EmailInterface::setFrom
Email::setSubject public function Sets the subject. Overrides EmailInterface::setSubject
Email::setTargetEntityTypeId public function Sets the target entity type ID. Overrides EmailInterface::setTargetEntityTypeId
Email::setTo public function Sets the "to" address. Overrides EmailInterface::setTo
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::entityManager Deprecated protected function Gets the entity manager.
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
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