FillPdfContextManagerInterface.php in FillPDF 5.0.x

Namespace

Drupal\fillpdf

File

src/FillPdfContextManagerInterface.php

<?php

namespace Drupal\fillpdf;


/**
 * Load entities from a FillPDF $context.
 *
 * Provides a common interface for loading and serialization of the $context
 * array returned by FillPdfLinkManipulator::parseRequest().
 *
 * @package Drupal\fillpdf\FillPdfContextManagerInterface
 */
interface FillPdfContextManagerInterface {

  /**
   * Loads the entities specified in $context['entity_ids'].
   *
   * @param array $context
   *   The FillPDF request context as returned by
   *   FillPdfLinkManipulatorInterface::parseLink().
   *
   * @return \Drupal\Core\Entity\EntityInterface[][]
   *   Multidimensional array of entities, keyed by ID and grouped by entity
   *   type. Returns an empty array if no matching entities are found.
   *
   * @see \Drupal\fillpdf\FillPdfLinkManipulatorInterface::parseLink()
   */
  public function loadEntities(array $context);

}

Interfaces

Name	Description
FillPdfContextManagerInterface	Load entities from a FillPDF $context.