You are here

Home » API reference » Heartbeat 8 » HeartbeatInterface.php

interface HeartbeatInterface in Heartbeat 8

Provides an interface for defining Heartbeat entities.

Hierarchy

Expanded class hierarchy of HeartbeatInterface

All classes that implement HeartbeatInterface

5 files declare their use of HeartbeatInterface
HeartbeatController.php in src/Controller/HeartbeatController.php
HeartbeatRevisionRevertForm.php in src/Form/HeartbeatRevisionRevertForm.php
HeartbeatRevisionRevertTranslationForm.php in src/Form/HeartbeatRevisionRevertTranslationForm.php
HeartbeatStorage.php in src/HeartbeatStorage.php
HeartbeatStorageInterface.php in src/HeartbeatStorageInterface.php

File

src/Entity/HeartbeatInterface.php, line 17

Namespace

Drupal\heartbeat\Entity
View source 
interface HeartbeatInterface extends RevisionableInterface, RevisionLogInterface, EntityChangedInterface, EntityOwnerInterface {

  // Add get/set methods for your configuration properties here.

  /**
   * Gets the Heartbeat type.
   *
   * @return string
   *   The Heartbeat type.
   */
  public function getType();

  /**
   * Gets the Heartbeat name.
   *
   * @return string
   *   Name of the Heartbeat.
   */
  public function getName();

  /**
   * Sets the Heartbeat name.
   *
   * @param string $name
   *   The Heartbeat name.
   *
   * @return \Drupal\heartbeat\Entity\HeartbeatInterface
   *   The called Heartbeat entity.
   */
  public function setName($name);

  /**
   * Gets the Heartbeat message.
   *
   * @return string
   *   Message of the Heartbeat.
   */
  public function getMessage();

  /**
   * Sets the Heartbeat Message.
   *
   * @param $name
   * @return
   * @internal param string $message The Heartbeat Message
   */
  public function setMessage($message);

  /**
   * Gets the Heartbeat user.
   *
   * @return int
   *   The uid of the Heartbeat's user.
   */
  public function getUid();

  /**
   * Sets the Heartbeat user.
   *
   * @param int uid
   *   The Heartbeat user.
   *
   */
  public function setUid($uid);

  /**
   * Gets the Heartbeat's associated node nid.
   *
   * @return int
   *   The nid of the Heartbeat's associated node.
   */
  public function getNid();

  /**
   * Sets the Heartbeat user.
   *
   * @param int uid
   *   The Heartbeat user.
   *
   */
  public function setNid($nid);

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

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

  /**
   * Returns the Heartbeat published status indicator.
   *
   * Unpublished Heartbeat are only visible to restricted users.
   *
   * @return bool
   *   TRUE if the Heartbeat is published.
   */
  public function isPublished();

  /**
   * Sets the published status of a Heartbeat.
   *
   * @param bool $published
   *   TRUE to set this Heartbeat to published, FALSE to set it to unpublished.
   *
   * @return \Drupal\heartbeat\Entity\HeartbeatInterface
   *   The called Heartbeat entity.
   */
  public function setPublished($published);

  /**
   * Gets the Heartbeat revision creation timestamp.
   *
   * @return int
   *   The UNIX timestamp of when this revision was created.
   */
  public function getRevisionCreationTime();

  /**
   * Sets the Heartbeat revision creation timestamp.
   *
   * @param int $timestamp
   *   The UNIX timestamp of when this revision was created.
   *
   * @return \Drupal\heartbeat\Entity\HeartbeatInterface
   *   The called Heartbeat entity.
   */
  public function setRevisionCreationTime($timestamp);

  /**
   * Gets the Heartbeat revision author.
   *
   * @return \Drupal\user\UserInterface
   *   The user entity for the revision author.
   */
  public function getRevisionUser();

  /**
   * Sets the Heartbeat revision author.
   *
   * @param int $uid
   *   The user ID of the revision author.
   *
   * @return \Drupal\heartbeat\Entity\HeartbeatInterface
   *   The called Heartbeat entity.
   */
  public function setRevisionUserId($uid);

}

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::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
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
HeartbeatInterface::getCreatedTime public function Gets the Heartbeat creation timestamp. 1
HeartbeatInterface::getMessage public function Gets the Heartbeat message. 1
HeartbeatInterface::getName public function Gets the Heartbeat name. 1
HeartbeatInterface::getNid public function Gets the Heartbeat's associated node nid. 1
HeartbeatInterface::getRevisionCreationTime public function Gets the Heartbeat revision creation timestamp. Overrides RevisionLogInterface::getRevisionCreationTime
HeartbeatInterface::getRevisionUser public function Gets the Heartbeat revision author. Overrides RevisionLogInterface::getRevisionUser
HeartbeatInterface::getType public function Gets the Heartbeat type. 1
HeartbeatInterface::getUid public function Gets the Heartbeat user. 1
HeartbeatInterface::isPublished public function Returns the Heartbeat published status indicator. 1
HeartbeatInterface::setCreatedTime public function Sets the Heartbeat creation timestamp. 1
HeartbeatInterface::setMessage public function Sets the Heartbeat Message. 1
HeartbeatInterface::setName public function Sets the Heartbeat name. 1
HeartbeatInterface::setNid public function Sets the Heartbeat user. 1
HeartbeatInterface::setPublished public function Sets the published status of a Heartbeat. 1
HeartbeatInterface::setRevisionCreationTime public function Sets the Heartbeat revision creation timestamp. Overrides RevisionLogInterface::setRevisionCreationTime
HeartbeatInterface::setRevisionUserId public function Sets the Heartbeat revision author. Overrides RevisionLogInterface::setRevisionUserId
HeartbeatInterface::setUid public function Sets the Heartbeat user. 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::getRevisionLogMessage public function Returns the entity revision log message.
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID.
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message.
RevisionLogInterface::setRevisionUser public function Sets the entity revision author.