You are here

Home » API reference » Entity Print 8.2 » PdfEngineBase.php

abstract class PdfEngineBase in Entity Print 8.2

Base class for all PDF print engines.

Hierarchy

Expanded class hierarchy of PdfEngineBase

File

src/Plugin/EntityPrint/PrintEngine/PdfEngineBase.php, line 11

Namespace

Drupal\entity_print\Plugin\EntityPrint\PrintEngine
View source 
abstract class PdfEngineBase extends PrintEngineBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['default_paper_size'] = [
      '#title' => $this
        ->t('Paper Size'),
      '#type' => 'select',
      '#options' => $this
        ->getPaperSizes(),
      '#default_value' => $this->configuration['default_paper_size'],
      '#description' => $this
        ->t('The page size to print the PDF to.'),
      '#weight' => -10,
    ];
    $form['orientation'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Paper Orientation'),
      '#options' => [
        static::PORTRAIT => $this
          ->t('Portrait'),
        static::LANDSCAPE => $this
          ->t('Landscape'),
      ],
      '#description' => $this
        ->t('The paper orientation one of Landscape or Portrait'),
      '#default_value' => $this->configuration['orientation'],
      '#weight' => -9,
    ];
    $form['credentials'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('HTTP Authentication'),
      '#open' => !empty($this->configuration['username']) || !empty($this->configuration['password']),
      '#weight' => 10,
    ];
    $form['credentials']['username'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Username'),
      '#description' => $this
        ->t('If your website is behind HTTP Authentication you can set the username'),
      '#default_value' => $this->configuration['username'],
    ];
    $form['credentials']['password'] = [
      '#type' => 'password',
      '#title' => $this
        ->t('Password'),
      '#description' => $this
        ->t('If your website is behind HTTP Authentication you can set the password. Note this data is not encrypted and will be exported to config.'),
      '#default_value' => $this->configuration['password'],
    ];
    return $form;
  }

  /**
   * Gets the paper sizes supported.
   *
   * @return array
   *   An array of paper sizes keyed by their machine name.
   */
  protected abstract function getPaperSizes();

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'orientation' => 'portrait',
      'default_paper_size' => 'letter',
      'username' => '',
      'password' => '',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PdfEngineBase::buildConfigurationForm public function Form constructor. Overrides PrintEngineBase::buildConfigurationForm 2
PdfEngineBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides PrintEngineBase::defaultConfiguration 2
PdfEngineBase::getPaperSizes abstract protected function Gets the paper sizes supported. 2
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 3
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.
PrintEngineBase::$exportType protected property The export type plugin.
PrintEngineBase::calculateDependencies public function
PrintEngineBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
PrintEngineBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PrintEngineBase::getExportType public function Gets the export type. Overrides PrintEngineInterface::getExportType
PrintEngineBase::getInstallationInstructions public static function Gets the installation instructions for this Print engine. Overrides PrintEngineInterface::getInstallationInstructions 3
PrintEngineBase::LANDSCAPE constant
PrintEngineBase::PORTRAIT constant
PrintEngineBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PrintEngineBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 2
PrintEngineBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
PrintEngineBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 3
PrintEngineInterface::addPage public function Add a string of HTML to a new page. 7
PrintEngineInterface::dependenciesAvailable public static function Checks if the Print engine dependencies are available. 7
PrintEngineInterface::getBlob public function Gets the binary data for the printed document. 7
PrintEngineInterface::getPrintObject public function Gets the object for this Print engine. 7
PrintEngineInterface::send public function Send the Print contents to the browser. 7
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.