interface EasyEmailTypeInterface in Easy Email 8

Same name and namespace in other branches

2.0.x src/Entity/EasyEmailTypeInterface.php \Drupal\easy_email\Entity\EasyEmailTypeInterface

Provides an interface for defining Email template entities.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\easy_email\Entity\EasyEmailTypeInterface

Expanded class hierarchy of EasyEmailTypeInterface

All classes that implement EasyEmailTypeInterface

4 files declare their use of EasyEmailTypeInterface

EasyEmailController.php in src/Controller/EasyEmailController.php
EasyEmailTemplatePreviewTest.php in tests/src/Functional/EasyEmailTemplatePreviewTest.php
EasyEmailTestBase.php in tests/src/Functional/EasyEmailTestBase.php
easy_email.module in ./easy_email.module: Contains easy_email.module.

File

src/Entity/EasyEmailTypeInterface.php, line 10

Namespace

Drupal\easy_email\Entity

View source

interface EasyEmailTypeInterface extends ConfigEntityInterface {

  /**
   * @return string
   */
  public function getId();

  /**
   * @param string $id
   *
   * @return $this
   */
  public function setId($id);

  /**
   * @return string
   */
  public function getLabel();

  /**
   * @param string $label
   *
   * @return $this
   */
  public function setLabel($label);

  /**
   * @return string
   */
  public function getKey();

  /**
   * @param string $key
   *
   * @return EasyEmailType
   */
  public function setKey($key);

  /**
   * @return array
   */
  public function getRecipient();

  /**
   * @param array $recipient
   *
   * @return $this
   */
  public function setRecipient($recipient);

  /**
   * @return array
   */
  public function getCc();

  /**
   * @param array $cc
   *
   * @return $this
   */
  public function setCc($cc);

  /**
   * @return array
   */
  public function getBcc();

  /**
   * @param array $bcc
   *
   * @return $this
   */
  public function setBcc($bcc);

  /**
   * @return string
   */
  public function getFromName();

  /**
   * @param string $fromName
   *
   * @return $this
   */
  public function setFromName($fromName);

  /**
   * @return string
   */
  public function getFromAddress();

  /**
   * @param string $fromAddress
   *
   * @return $this
   */
  public function setFromAddress($fromAddress);

  /**
   * @return string
   */
  public function getReplyToAddress();

  /**
   * @param string $replyToAddress
   *
   * @return $this
   */
  public function setReplyToAddress($replyToAddress);

  /**
   * @return string
   */
  public function getSubject();

  /**
   * @param string $subject
   *
   * @return $this
   */
  public function setSubject($subject);

  /**
   * @return string
   */
  public function getInboxPreview();

  /**
   * @param string $inboxPreview
   *
   * @return $this
   */
  public function setInboxPreview($inboxPreview);

  /**
   * @return array
   */
  public function getBodyHtml();

  /**
   * @param array $bodyHtml
   *
   * @return $this
   */
  public function setBodyHtml($bodyHtml);

  /**
   * @return string
   */
  public function getBodyPlain();

  /**
   * @param string $bodyPlain
   *
   * @return $this
   */
  public function setBodyPlain($bodyPlain);

  /**
   * @return bool
   */
  public function getGenerateBodyPlain();

  /**
   * @param bool $generateBodyPlain
   *
   * @return EasyEmailType
   */
  public function setGenerateBodyPlain($generateBodyPlain);

  /**
   * @return array
   */
  public function getAttachment();

  /**
   * @param array $attachment
   *
   * @return $this
   */
  public function setAttachment($attachment);

  /**
   * @return bool
   */
  public function getSaveAttachment();

  /**
   * @param bool $saveAttachment
   *
   * @return $this
   */
  public function setSaveAttachment($saveAttachment);

  /**
   * @return string
   */
  public function getAttachmentScheme();

  /**
   * @param string $scheme
   *
   * @return $this
   */
  public function setAttachmentScheme($scheme);

  /**
   * @return string
   */
  public function getAttachmentDirectory();

  /**
   * @param string $directory
   *
   * @return $this
   */
  public function setAttachmentDirectory($directory);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EasyEmailTypeInterface::getAttachment	public	function		1
EasyEmailTypeInterface::getAttachmentDirectory	public	function		1
EasyEmailTypeInterface::getAttachmentScheme	public	function		1
EasyEmailTypeInterface::getBcc	public	function		1
EasyEmailTypeInterface::getBodyHtml	public	function		1
EasyEmailTypeInterface::getBodyPlain	public	function		1
EasyEmailTypeInterface::getCc	public	function		1
EasyEmailTypeInterface::getFromAddress	public	function		1
EasyEmailTypeInterface::getFromName	public	function		1
EasyEmailTypeInterface::getGenerateBodyPlain	public	function		1
EasyEmailTypeInterface::getId	public	function		1
EasyEmailTypeInterface::getInboxPreview	public	function		1
EasyEmailTypeInterface::getKey	public	function		1
EasyEmailTypeInterface::getLabel	public	function		1
EasyEmailTypeInterface::getRecipient	public	function		1
EasyEmailTypeInterface::getReplyToAddress	public	function		1
EasyEmailTypeInterface::getSaveAttachment	public	function		1
EasyEmailTypeInterface::getSubject	public	function		1
EasyEmailTypeInterface::setAttachment	public	function		1
EasyEmailTypeInterface::setAttachmentDirectory	public	function		1
EasyEmailTypeInterface::setAttachmentScheme	public	function		1
EasyEmailTypeInterface::setBcc	public	function		1
EasyEmailTypeInterface::setBodyHtml	public	function		1
EasyEmailTypeInterface::setBodyPlain	public	function		1
EasyEmailTypeInterface::setCc	public	function		1
EasyEmailTypeInterface::setFromAddress	public	function		1
EasyEmailTypeInterface::setFromName	public	function		1
EasyEmailTypeInterface::setGenerateBodyPlain	public	function		1
EasyEmailTypeInterface::setId	public	function		1
EasyEmailTypeInterface::setInboxPreview	public	function		1
EasyEmailTypeInterface::setKey	public	function		1
EasyEmailTypeInterface::setLabel	public	function		1
EasyEmailTypeInterface::setRecipient	public	function		1
EasyEmailTypeInterface::setReplyToAddress	public	function		1
EasyEmailTypeInterface::setSaveAttachment	public	function		1
EasyEmailTypeInterface::setSubject	public	function		1
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface EasyEmailTypeInterface in Easy Email 8

Hierarchy

File

Namespace

Members

API Navigation