interface HeartbeatStreamInterface in Heartbeat 8

Provides an interface for defining Heartbeat stream entities.

Hierarchy

interface \Drupal\Core\Entity\RevisionableInterface; interface \Drupal\Core\Entity\RevisionLogInterface; interface \Drupal\Core\Entity\EntityChangedInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\heartbeat\Entity\HeartbeatStreamInterface

Expanded class hierarchy of HeartbeatStreamInterface

All classes that implement HeartbeatStreamInterface

5 files declare their use of HeartbeatStreamInterface

HeartbeatStreamController.php in src/Controller/HeartbeatStreamController.php
HeartbeatStreamRevisionRevertForm.php in src/Form/HeartbeatStreamRevisionRevertForm.php
HeartbeatStreamRevisionRevertTranslationForm.php in src/Form/HeartbeatStreamRevisionRevertTranslationForm.php
HeartbeatStreamStorage.php in src/HeartbeatStreamStorage.php
HeartbeatStreamStorageInterface.php in src/HeartbeatStreamStorageInterface.php

File

src/Entity/HeartbeatStreamInterface.php, line 17

Namespace

Drupal\heartbeat\Entity

View source

interface HeartbeatStreamInterface extends RevisionableInterface, RevisionLogInterface, EntityChangedInterface, EntityOwnerInterface {

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

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

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

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

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

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

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

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

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

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

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

  /**
   * @return mixed
   */
  public function getClass();

  /**
   * @param mixed $class
   */
  public function setClass($class);

  /**
   * @return mixed
   */
  public function getRealClass();

  /**
   * @param mixed $real_class
   */
  public function setRealClass($real_class);

  /**
   * @return mixed
   */
  public function getPath();

  /**
   * @param mixed $path
   */
  public function setPath($path);

  /**
   * @return mixed
   */
  public function getTitle();

  /**
   * @param mixed $title
   */
  public function setTitle($title);

  /**
   * @return mixed
   */
  public function getModule();

  /**
   * @param mixed $module
   */
  public function setModule($module);

  /**
   * @return mixed
   */
  public function getVariables();

  /**
   * @param mixed $variables
   */
  public function setVariables($variables);

  /**
   * @return mixed
   */
  public function getSettings();

  /**
   * @param mixed $settings
   */
  public function setSettings($settings);

  /**
   * @return mixed
   */
  public function getTypes();

  /**
   * @param $heartbeat_types
   * @return mixed
   */
  public function setTypes($heartbeat_types);

  /**
   * @return mixed
   */
  public function setWeight($weight);

  /**
   * @param $weight
   * @return mixed
   */
  public function getWeight();

}

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
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
HeartbeatStreamInterface::getClass	public	function		1
HeartbeatStreamInterface::getCreatedTime	public	function	Gets the Heartbeat stream creation timestamp.	1
HeartbeatStreamInterface::getModule	public	function		1
HeartbeatStreamInterface::getName	public	function	Gets the Heartbeat stream name.	1
HeartbeatStreamInterface::getPath	public	function		1
HeartbeatStreamInterface::getRealClass	public	function		1
HeartbeatStreamInterface::getRevisionCreationTime	public	function	Gets the Heartbeat stream revision creation timestamp. Overrides RevisionLogInterface::getRevisionCreationTime
HeartbeatStreamInterface::getRevisionUser	public	function	Gets the Heartbeat stream revision author. Overrides RevisionLogInterface::getRevisionUser
HeartbeatStreamInterface::getSettings	public	function		1
HeartbeatStreamInterface::getTitle	public	function		1
HeartbeatStreamInterface::getTypes	public	function		1
HeartbeatStreamInterface::getVariables	public	function		1
HeartbeatStreamInterface::getWeight	public	function		1
HeartbeatStreamInterface::isPublished	public	function	Returns the Heartbeat stream published status indicator.	1
HeartbeatStreamInterface::setClass	public	function		1
HeartbeatStreamInterface::setCreatedTime	public	function	Sets the Heartbeat stream creation timestamp.	1
HeartbeatStreamInterface::setModule	public	function		1
HeartbeatStreamInterface::setName	public	function	Sets the Heartbeat stream name.	1
HeartbeatStreamInterface::setPath	public	function		1
HeartbeatStreamInterface::setPublished	public	function	Sets the published status of a Heartbeat stream.	1
HeartbeatStreamInterface::setRealClass	public	function		1
HeartbeatStreamInterface::setRevisionCreationTime	public	function	Sets the Heartbeat stream revision creation timestamp. Overrides RevisionLogInterface::setRevisionCreationTime
HeartbeatStreamInterface::setRevisionUserId	public	function	Sets the Heartbeat stream revision author. Overrides RevisionLogInterface::setRevisionUserId
HeartbeatStreamInterface::setSettings	public	function		1
HeartbeatStreamInterface::setTitle	public	function		1
HeartbeatStreamInterface::setTypes	public	function		1
HeartbeatStreamInterface::setVariables	public	function		1
HeartbeatStreamInterface::setWeight	public	function		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.

You are here

interface HeartbeatStreamInterface in Heartbeat 8

Hierarchy

File

Namespace

Members

API Navigation