interface FilenameGeneratorInterface in Entity Print 8.2

The filename generator interface.

Hierarchy

• interface \Drupal\entity_print\FilenameGeneratorInterface

4 files declare their use of FilenameGeneratorInterface

ContentEntityRenderer.php in src/Renderer/ContentEntityRenderer.php

FilenameGeneratorTest.php in tests/src/Kernel/FilenameGeneratorTest.php

RendererBase.php in src/Renderer/RendererBase.php

ViewsRendererTest.php in modules/entity_print_views/tests/src/Kernel/ViewsRendererTest.php

File

src/FilenameGeneratorInterface.php, line 8

Namespace

Drupal\entity_print

interface FilenameGeneratorInterface {

  /**
   * The filename used when we're unable to calculate a filename.
   *
   * @var string
   */
  const DEFAULT_FILENAME = 'document';

  /**
   * Generates a filename to be used for a printed document.
   *
   * @param \Drupal\Core\Entity\EntityInterface[] $entities
   *   An array of entities to generate a filename for.
   * @param callable $entity_label_callback
   *   (optional) A function to generate the label for an individual entity.
   *
   * @return string
   *   The generated filename.
   */
  public function generateFilename(array $entities, callable $entity_label_callback = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
FilenameGeneratorInterface::DEFAULT_FILENAME		constant	The filename used when we're unable to calculate a filename.
FilenameGeneratorInterface::generateFilename	public	function	Generates a filename to be used for a printed document.	1