interface PdfExportProcessorInterface in PDF Export 7

@file PdfProcessor interface.

Hierarchy

• interface \PdfExportProcessorInterface

File

includes/PdfExportProcessorInterface.inc, line 7

PdfProcessor interface.

interface PdfExportProcessorInterface {

  /**
   * Creates an instance of the library.
   */
  public function loadLibrary();

  /**
   * Defines the base path.
   */
  public function setBasePath($base_path);

  /**
   * Adds css styles to the pdf.
   *
   * @param string $styles
   *   CSS styles.
   */
  public function addCssStyles($styles);

  /**
   * Sets the HTML to be exported.
   *
   * @param string $html
   *   Final HTML string to be exported.
   */
  public function setHTML($html);

  /**
   * Enable debugging for troubleshooting.
   */
  public function enableDebug();

  /**
   * Save generated file to the filesystem.
   *
   * @param string $filename
   *   The path where the pdf should be exported.
   *
   * @return bool
   *   TRUE if successfully exported. FALSE otherwise.
   */
  public function save($filename);

}

Members

Name	Modifiers	Type	Description	Overrides
PdfExportProcessorInterface::addCssStyles	public	function	Adds css styles to the pdf.	1
PdfExportProcessorInterface::enableDebug	public	function	Enable debugging for troubleshooting.	1
PdfExportProcessorInterface::loadLibrary	public	function	Creates an instance of the library.	1
PdfExportProcessorInterface::save	public	function	Save generated file to the filesystem.	1
PdfExportProcessorInterface::setBasePath	public	function	Defines the base path.	1
PdfExportProcessorInterface::setHTML	public	function	Sets the HTML to be exported.	1