PrintableEntityManagerInterface.php in Printer and PDF versions for Drupal 8+ 8

Namespace

Drupal\printable

File

src/PrintableEntityManagerInterface.php

<?php

namespace Drupal\printable;

use Drupal\Core\Entity\EntityInterface;

/**
 * Entity manager interface for the printable module.
 */
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();

}

Interfaces

Name	Description
PrintableEntityManagerInterface	Entity manager interface for the printable module.