You are here

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

abstract class PrintEngineBase in Entity Print 8.2

The PrintEngineBase class.

Hierarchy

Expanded class hierarchy of PrintEngineBase

6 files declare their use of PrintEngineBase
NotAvailablePrintEngine.php in tests/modules/entity_print_test/src/Plugin/EntityPrint/PrintEngine/NotAvailablePrintEngine.php
PdfEngineBase.php in src/Plugin/EntityPrint/PrintEngine/PdfEngineBase.php
PrintExceptionEngine.php in tests/modules/entity_print_test/src/Plugin/EntityPrint/PrintEngine/PrintExceptionEngine.php
TcPdfv1.php in src/Plugin/EntityPrint/PrintEngine/TcPdfv1.php
TestPrintEngine.php in tests/modules/entity_print_test/src/Plugin/EntityPrint/PrintEngine/TestPrintEngine.php

... See full list

File

src/Plugin/PrintEngineBase.php, line 14

Namespace

Drupal\entity_print\Plugin
View source 
abstract class PrintEngineBase extends PluginBase implements PrintEngineInterface, ContainerFactoryPluginInterface {
  const PORTRAIT = 'portrait';
  const LANDSCAPE = 'landscape';

  /**
   * The export type plugin.
   *
   * @var \Drupal\entity_print\Plugin\ExportTypeInterface
   */
  protected $exportType;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.entity_print.export_type')
      ->createInstance($plugin_definition['export_type']));
  }

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

  /**
   * {@inheritdoc}
   */
  public static function getInstallationInstructions() {
    return 'Please install using composer';
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {

    // No validation required by default.
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = OptGroup::flattenOptions($form_state
      ->getValues());
    foreach ($this
      ->defaultConfiguration() as $key => $value) {
      $this->configuration[$key] = isset($values[$key]) ? $values[$key] : NULL;
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration + $this
      ->defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

}

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.
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::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 4
PrintEngineBase::calculateDependencies public function
PrintEngineBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
PrintEngineBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 4
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.