You are here

Home » API reference » PDF generator API 2.x » DompdfGenerator.php

class DompdfGenerator in PDF generator API 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/PdfGenerator/DompdfGenerator.php \Drupal\pdf_api\Plugin\PdfGenerator\DompdfGenerator

A PDF generator plugin for the dompdf library.

Plugin annotation


@PdfGenerator(
  id = "dompdf",
  module = "pdf_api",
  title = @Translation("DOMPDF"),
  description = @Translation("PDF generator using the DOMPDF generator.")
)

Hierarchy

Expanded class hierarchy of DompdfGenerator

File

src/Plugin/PdfGenerator/DompdfGenerator.php, line 30
Contains \Drupal\pdf_api\Plugin\DompdfGenerator.

Namespace

Drupal\pdf_api\Plugin\PdfGenerator
View source 
class DompdfGenerator extends PdfGeneratorBase implements ContainerFactoryPluginInterface {

  /**
   * Instance of the DOMPDF class library.
   *
   * @var \DOMPDF
   */
  protected $generator;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, DOMPDF $generator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->generator = $generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('dompdf'));
  }

  /**
   * {@inheritdoc}
   */
  public function setter($pdf_content, $pdf_location, $save_pdf, $paper_orientation, $paper_size, $footer_content, $header_content, $path_to_binary = '') {
    $this
      ->setPageOrientation($paper_orientation);
    $this
      ->addPage($pdf_content);
    $this
      ->setHeader($header_content);
  }

  /**
   * {@inheritdoc}
   */
  public function getObject() {
    return $this->generator;
  }

  /**
   * {@inheritdoc}
   */
  public function setHeader($text) {
    $canvas = $this->generator
      ->get_canvas();
    $canvas
      ->page_text(72, 18, "Header: {PAGE_COUNT}", "", 11, array(
      0,
      0,
      0,
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function addPage($html) {
    $this->generator
      ->load_html($html);
    $this->generator
      ->render();
  }

  /**
   * {@inheritdoc}
   */
  public function setPageOrientation($orientation = PdfGeneratorInterface::PORTRAIT) {
    $this->generator
      ->set_paper("", $orientation);
  }

  /**
   * {@inheritdoc}
   */
  public function setPageSize($page_size) {
    if ($this
      ->isValidPageSize($page_size)) {
      $this->generator
        ->set_paper($page_size);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setFooter($text) {

    // @todo see issue over here: https://github.com/dompdf/dompdf/issues/571
  }

  /**
   * {@inheritdoc}
   */
  public function save($location) {
    $content = $this->generator
      ->output([]);
    file_put_contents($location, $content);
  }

  /**
   * {@inheritdoc}
   */
  public function send() {
    $this->generator
      ->stream("pdf", array(
      'Attachment' => 0,
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function stream($filelocation) {
    $this->generator
      ->Output($filelocation, "F");
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DompdfGenerator::$generator protected property Instance of the DOMPDF class library.
DompdfGenerator::addPage public function Add a page to the generated PDF. Overrides PdfGeneratorInterface::addPage
DompdfGenerator::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DompdfGenerator::getObject public function Returns instances of PDF libraries. Overrides PdfGeneratorInterface::getObject
DompdfGenerator::save public function Generate and save the PDF at a specific location. Overrides PdfGeneratorInterface::save
DompdfGenerator::send public function The name of the file to be downloaded. Overrides PdfGeneratorInterface::send
DompdfGenerator::setFooter public function Sets the footer in the PDF. Overrides PdfGeneratorInterface::setFooter
DompdfGenerator::setHeader public function Sets the header in the PDF. Overrides PdfGeneratorInterface::setHeader
DompdfGenerator::setPageOrientation public function Set the paper orientation of the generated PDF pages. Overrides PdfGeneratorInterface::setPageOrientation
DompdfGenerator::setPageSize public function Set the page size of the generated PDF pages. Overrides PdfGeneratorInterface::setPageSize
DompdfGenerator::setter public function Set the various options for PDF. Overrides PdfGeneratorInterface::setter
DompdfGenerator::stream public function Stream the PDF to the browser. Overrides PdfGeneratorInterface::stream
DompdfGenerator::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PdfGeneratorBase::$options protected property The global options for the PDF generator.
PdfGeneratorBase::displayErrors public function Display error messages. Overrides PdfGeneratorInterface::displayErrors
PdfGeneratorBase::getDescription public function Returns the administrative description for this generator plugin. Overrides PdfGeneratorInterface::getDescription
PdfGeneratorBase::getId public function Returns the administrative id for this generator plugin. Overrides PdfGeneratorInterface::getId
PdfGeneratorBase::getLabel public function Returns the administrative label for this generator plugin. Overrides PdfGeneratorInterface::getLabel
PdfGeneratorBase::getPageDimensions protected function Get the dimensions of a given page size.
PdfGeneratorBase::getStderr public function Get stderr from teh command that was run. Overrides PdfGeneratorInterface::getStderr 1
PdfGeneratorBase::getStdout public function Get stdout from the command that was run. Overrides PdfGeneratorInterface::getStdout 1
PdfGeneratorBase::isValidPageSize protected function Checks if a given page size is valid.
PdfGeneratorBase::pageSizes protected function Get an array of all valid page sizes, keyed by the page size name.
PdfGeneratorBase::setOptions public function Set global options.
PdfGeneratorInterface::LANDSCAPE constant Landscape paper orientation.
PdfGeneratorInterface::PORTRAIT constant Portrait paper orientation.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.