You are here

Home » API reference » Previewable email templates 8.3 » PetInterface.php

interface PetInterface in Previewable email templates 8.3

Provides an interface for defining Pet entities.

@package pet

@todo: complete function documentation.

Hierarchy

Expanded class hierarchy of PetInterface

All classes that implement PetInterface

8 files declare their use of PetInterface
PetDiffRevisionController.php in src/Controller/PetDiffRevisionController.php
PetDiffRevisionOverviewForm.php in src/Form/PetDiffRevisionOverviewForm.php
PetPreviewForm.php in src/Form/PetPreviewForm.php
PetRevisionController.php in src/Controller/PetRevisionController.php
PetRevisionRevertForm.php in src/Form/PetRevisionRevertForm.php

... See full list

File

src/Entity/PetInterface.php, line 17

Namespace

Drupal\pet\Entity
View source 
interface PetInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, RevisionLogInterface {
  public function getBcc();
  public function setBcc($bcc);

  /**
   * Get plain body text.
   *
   * @return string
   *   Body text.
   */
  public function getBody();

  /**
   * Set the plain body text.
   *
   * @param string $mail_body
   *   Body text.
   *
   * @return \Drupal\pet\Entity\PetInterface
   *   The called Pet entity.
   */
  public function setBody($mail_body);

  /**
   * Get HTML body text.
   *
   * @return string
   *   HTML body text.
   */
  public function getBodyHtml();

  /**
   * Set the HTML body text.
   *
   * @param string $mail_body_html
   *   HTML body text.
   *
   * @return \Drupal\pet\Entity\PetInterface
   *   The called Pet entity.
   */
  public function setBodyHtml($mail_body_html);
  public function getCc();
  public function setCc($cc);

  /**
   * Gets the Pet creation timestamp.
   *
   * @return int
   *   Creation timestamp of the Pet.
   */
  public function getCreatedTime();

  /**
   * Sets the Pet creation timestamp.
   *
   * @param int $timestamp
   *   The Pet creation timestamp.
   *
   * @return \Drupal\pet\Entity\PetInterface
   *   The called Pet entity.
   */
  public function setCreatedTime($timestamp);

  /**
   * Get HTML body format id.
   *
   * @return string
   *   The format id.
   */
  public function getFormat();

  /**
   * Set the HTML body format.
   *
   * @param string $format
   *   The format id.
   *
   * @return \Drupal\pet\Entity\PetInterface
   *   The called Pet entity.
   */
  public function setFormat($format);
  public function getRecipientCallback();
  public function setRecipientCallback($recipient_callback);
  public function getReplyTo();
  public function setReplyTo($reply_to);
  public function getSendPlain();
  public function setSendPlain($send_plain);
  public function getSubject();
  public function setSubject($subject);

  /**
   * Get the Pet title.
   *
   * @return string
   *   Pet title.
   */
  public function getTitle();

  /**
   * Set the Pet title.
   *
   * @param string $title
   *   Title.
   *
   * @return \Drupal\pet\Entity\PetInterface
   *   Pet entity.
   */
  public function setTitle($title);
  public function isPublished();
  public function setPublished($published);

  /*
   * Class specific functions.
   */

  /**
   * Shortcut to get Pet configuration.
   *
   * @return \Drupal\Core\Config\ImmutableConfig
   *   Pet configuration.
   */
  public function getConfig();

  /**
   * Pet logging level.
   *
   * @return int
   *   Logging level, see PET_LOGGER_NONE, PET_LOGGER_ERRORS or PET_LOGGER_ALL.
   */
  public function getLoggingLevel();

  /**
   * Log message, taking Pet logging configuration into account.
   *
   * @param string $message
   *   Message to log, can include string replacement tokens.
   * @param array $replacements
   *   Replacements for the message.
   * @param string $type
   *   Message type: 'error' or 'debug'.
   */
  public function log($message, array $replacements = [], $type = 'debug');

  /**
   * Send PET to one or more recipients.
   *
   * @param array $recipients
   *   Recipient email addresses.
   * @param array $context
   *   Context items to be used for token substitutions.
   *   E.g.:
   *    [
   *     'uid' => NULL,
   *     'nid' => 4,
   *    ]
   *   'uid' will always be set when preparing data, either the user id matching
   *   recipient address, or '0' in case of no match.
   *   Modules providing tokens for PET should implement
   *   hook_pet_substitutions_alter(&$substitutions).
   *
   * @return array
   *   Result value of MailManager::mail() for each mail keyed by recipient
   *   email address.
   */
  public function sendMail(array $recipients, array $context);

}

Members

Namesort descending 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
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
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::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
EntityOwnerInterface::getOwner public function Returns the entity owner's user entity. 1
EntityOwnerInterface::getOwnerId public function Returns the entity owner's user ID. 1
EntityOwnerInterface::setOwner public function Sets the entity owner's user entity. 1
EntityOwnerInterface::setOwnerId public function Sets the entity owner's user ID. 1
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values. 1
PetInterface::getBcc public function 1
PetInterface::getBody public function Get plain body text. 1
PetInterface::getBodyHtml public function Get HTML body text. 1
PetInterface::getCc public function 1
PetInterface::getConfig public function Shortcut to get Pet configuration. 1
PetInterface::getCreatedTime public function Gets the Pet creation timestamp. 1
PetInterface::getFormat public function Get HTML body format id. 1
PetInterface::getLoggingLevel public function Pet logging level. 1
PetInterface::getRecipientCallback public function 1
PetInterface::getReplyTo public function 1
PetInterface::getSendPlain public function 1
PetInterface::getSubject public function 1
PetInterface::getTitle public function Get the Pet title. 1
PetInterface::isPublished public function 1
PetInterface::log public function Log message, taking Pet logging configuration into account. 1
PetInterface::sendMail public function Send PET to one or more recipients. 1
PetInterface::setBcc public function 1
PetInterface::setBody public function Set the plain body text. 1
PetInterface::setBodyHtml public function Set the HTML body text. 1
PetInterface::setCc public function 1
PetInterface::setCreatedTime public function Sets the Pet creation timestamp. 1
PetInterface::setFormat public function Set the HTML body format. 1
PetInterface::setPublished public function 1
PetInterface::setRecipientCallback public function 1
PetInterface::setReplyTo public function 1
PetInterface::setSendPlain public function 1
PetInterface::setSubject public function 1
PetInterface::setTitle public function Set the Pet title. 1
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
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. 1
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 1
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 1
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision. 1
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 1
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 1
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 1
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. 1
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. 1
RevisionLogInterface::getRevisionCreationTime public function Gets the entity revision creation timestamp. 1
RevisionLogInterface::getRevisionLogMessage public function Returns the entity revision log message.
RevisionLogInterface::getRevisionUser public function Gets the entity revision author.
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID.
RevisionLogInterface::setRevisionCreationTime public function Sets the entity revision creation timestamp. 1
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message.
RevisionLogInterface::setRevisionUser public function Sets the entity revision author.
RevisionLogInterface::setRevisionUserId public function Sets the entity revision author by ID.
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
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object. 1
TranslatableInterface::getTranslation public function Gets a translation of the data. 1
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 1
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language. 1
TranslatableInterface::hasTranslation public function Checks there is a translation for the given language code. 1
TranslatableInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 1
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one. 1
TranslatableInterface::isNewTranslation public function Checks whether the translation is new. 1
TranslatableInterface::isTranslatable public function Returns the translation support status. 1
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code. 1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. 1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. 1
TranslatableRevisionableInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. 1
TranslatableRevisionableInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. 1