You are here

interface PreviewLinkStorageInterface in Preview Link 8

Same name and namespace in other branches
  1. 2.x src/PreviewLinkStorageInterface.php \Drupal\preview_link\PreviewLinkStorageInterface
  2. 2.0.x src/PreviewLinkStorageInterface.php \Drupal\preview_link\PreviewLinkStorageInterface

Interface for Preview Link entities.

Hierarchy

Expanded class hierarchy of PreviewLinkStorageInterface

All classes that implement PreviewLinkStorageInterface

1 file declares its use of PreviewLinkStorageInterface
PreviewLinkTest.php in tests/src/Functional/PreviewLinkTest.php

File

src/PreviewLinkStorageInterface.php, line 11

Namespace

Drupal\preview_link
View source
interface PreviewLinkStorageInterface extends SqlEntityStorageInterface {

  /**
   * Gets the preview link for a given entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity we want the preview link for.
   *
   * @return \Drupal\preview_link\Entity\PreviewLinkInterface|false
   *   The preview link entity if it exists otherwise FALSE.
   */
  public function getPreviewLinkForEntity(ContentEntityInterface $entity);

  /**
   * Gets the preview link given entity type Id and entity Id.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity.
   *
   * @return \Drupal\preview_link\Entity\PreviewLinkInterface|false
   *   The preview link entity if it exists otherwise FALSE.
   */
  public function getPreviewLink(ContentEntityInterface $entity);

  /**
   * Creates a new preview link from a content entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity the preview link is for.
   *
   * @return \Drupal\preview_link\Entity\PreviewLinkInterface
   *   The preview link entity.
   */
  public function createPreviewLinkForEntity(ContentEntityInterface $entity);

  /**
   * Creates a new preview link from a entity type Id and entity Id.
   *
   * @param string $entity_type_id
   *   The entity type Id.
   * @param string $entity_id
   *   The entity id.
   *
   * @return \Drupal\preview_link\Entity\PreviewLinkInterface
   *   The preview link entity.
   */
  public function createPreviewLink($entity_type_id, $entity_id);

}

Members

Namesort descending Modifiers Type Description Overrides
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
EntityStorageInterface::deleteRevision public function Delete a specific entity revision. 4
EntityStorageInterface::FIELD_LOAD_CURRENT constant Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION constant Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery public function Gets an aggregated query instance. 1
EntityStorageInterface::getEntityType public function Gets the entity type definition. 1
EntityStorageInterface::getEntityTypeId public function Gets the entity type ID. 1
EntityStorageInterface::getQuery public function Gets an entity query instance. 1
EntityStorageInterface::hasData public function Determines if the storage contains any data. 1
EntityStorageInterface::load public function Loads one entity. 1
EntityStorageInterface::loadByProperties public function Load entities by their property values. 1
EntityStorageInterface::loadMultiple public function Loads one or more entities. 1
EntityStorageInterface::loadRevision public function Load a specific entity revision. 4
EntityStorageInterface::loadUnchanged public function Loads an unchanged entity from the database. 1
EntityStorageInterface::resetCache public function Resets the internal, static entity cache. 1
EntityStorageInterface::restore public function Restores a previously saved entity. 1
EntityStorageInterface::save public function Saves the entity permanently. 1
PreviewLinkStorageInterface::createPreviewLink public function Creates a new preview link from a entity type Id and entity Id. 1
PreviewLinkStorageInterface::createPreviewLinkForEntity public function Creates a new preview link from a content entity. 1
PreviewLinkStorageInterface::getPreviewLink public function Gets the preview link given entity type Id and entity Id. 1
PreviewLinkStorageInterface::getPreviewLinkForEntity public function Gets the preview link for a given entity. 1
SqlEntityStorageInterface::getTableMapping public function Gets a table mapping for the entity's SQL tables. 1