interface PdfEngineInterface in Entity Print 8

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurablePluginInterface
  • interface \Drupal\entity_print\Plugin\PdfEngineInterface

5 files declare their use of PdfEngineInterface

EntityPrintPdfBuilder.php in src/EntityPrintPdfBuilder.php

PdfBuilderInterface.php in src/PdfBuilderInterface.php

PdfEventBase.php in src/Event/PdfEventBase.php

PreSendPdfEvent.php in src/Event/PreSendPdfEvent.php

PreSendPdfMultipleEvent.php in src/Event/PreSendPdfMultipleEvent.php

File

src/Plugin/PdfEngineInterface.php, line 9

Namespace

Drupal\entity_print\Plugin

interface PdfEngineInterface extends PluginInspectionInterface, PluginFormInterface, ConfigurablePluginInterface {

  /**
   * Add a string of HTML to a new page.
   *
   * @param string $content
   *   The string of HTML to add to a new page.
   *
   * @return $this
   */
  public function addPage($content);

  /**
   * Send the PDF contents to the browser.
   *
   * @param $filename
   *   (optional) The filename if we want to force the browser to download.
   *
   * @throws \Drupal\entity_print\PdfEngineException
   *   Thrown when PDF generation fails.
   */
  public function send($filename = NULL);

  /**
   * Checks if the PDF engine dependencies are available.
   *
   * @return bool
   *   TRUE if this implementation has its dependencies met otherwise FALSE.
   */
  public static function dependenciesAvailable();

  /**
   * Gets the installation instructions for this PDF engine.
   *
   * @return string
   *   A description of how the user can meet the dependencies for this engine.
   */
  public static function getInstallationInstructions();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	1
ConfigurablePluginInterface::getConfiguration	public	function	Gets this plugin's configuration.	1
ConfigurablePluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	1
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PdfEngineInterface::addPage	public	function	Add a string of HTML to a new page.	4
PdfEngineInterface::dependenciesAvailable	public static	function	Checks if the PDF engine dependencies are available.	4
PdfEngineInterface::getInstallationInstructions	public static	function	Gets the installation instructions for this PDF engine.	1
PdfEngineInterface::send	public	function	Send the PDF contents to the browser.	4
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2