You are here

interface PrintableEntityManagerInterface in Printer and PDF versions for Drupal 8+ 8

Same name and namespace in other branches
  1. 2.x src/PrintableEntityManagerInterface.php \Drupal\printable\PrintableEntityManagerInterface

Entity manager interface for the printable module.

Hierarchy

Expanded class hierarchy of PrintableEntityManagerInterface

All classes that implement PrintableEntityManagerInterface

7 files declare their use of PrintableEntityManagerInterface
FormatConfigurationFormPdf.php in src/Form/FormatConfigurationFormPdf.php
FormatConfigurationFormPrint.php in src/Form/FormatConfigurationFormPrint.php
LinksConfigurationForm.php in src/Form/LinksConfigurationForm.php
PdfLinksConfigurationForm.php in src/Form/PdfLinksConfigurationForm.php
PrintableConfigurationForm.php in src/Form/PrintableConfigurationForm.php

... See full list

File

src/PrintableEntityManagerInterface.php, line 10

Namespace

Drupal\printable
View source
interface PrintableEntityManagerInterface {

  /**
   * Gets the ID of the type of the entity.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   *   The entity to check a printable version is available for.
   *
   * @return string
   *   The entity type ID.
   */
  public function getEntityName(EntityInterface $entity);

  /**
   * Get the entities that printable is available for.
   *
   * @return array
   *   An array of entity definitions keyed by the entity type.
   */
  public function getPrintableEntities();

  /**
   * Check if an entity has a printable version available for it.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   *   The entity to check a printable version is available for.
   *
   * @return bool
   *   TRUE if the entity has a printable version available, FALSE if not.
   */
  public function isPrintableEntity(EntityInterface $entity);

  /**
   * Get the entities that Printable can generate hardcopies for.
   *
   * @return array
   *   An array of entity definitions keyed by the entity type.
   */
  public function getCompatibleEntities();

}

Members

Namesort descending Modifiers Type Description Overrides
PrintableEntityManagerInterface::getCompatibleEntities public function Get the entities that Printable can generate hardcopies for. 1
PrintableEntityManagerInterface::getEntityName public function Gets the ID of the type of the entity. 1
PrintableEntityManagerInterface::getPrintableEntities public function Get the entities that printable is available for. 1
PrintableEntityManagerInterface::isPrintableEntity public function Check if an entity has a printable version available for it. 1