You are here

Home » API reference » Entity Print 8 » TestPdfEngine.php

class TestPdfEngine in Entity Print 8

Plugin annotation


@PdfEngine(
  id = "testpdfengine",
  label= @Translation("Test PDF Engine")
)

Hierarchy

Expanded class hierarchy of TestPdfEngine

File

tests/modules/entity_print_test/src/Plugin/EntityPrint/PdfEngine/TestPdfEngine.php, line 15

Namespace

Drupal\entity_print_test\Plugin\EntityPrint\PdfEngine
View source 
class TestPdfEngine extends PdfEngineBase {

  /**
   * @var string
   */
  protected $html;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function send($filename = NULL) {

    // Echo the response and then flush, just like a PDF implementation would.
    echo 'Using testpdfengine - ' . $this->configuration['test_engine_suffix'];
    echo $this->html;
    flush();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['test_engine_setting'] = [
      '#title' => $this
        ->t('Test setting'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['test_engine_setting'],
      '#description' => $this
        ->t('Test setting'),
    ];
    $form['test_engine_suffix'] = [
      '#title' => $this
        ->t('Suffix'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['test_engine_suffix'],
      '#description' => $this
        ->t('Suffix'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['test_engine_setting'] = $form_state
      ->getValue('test_engine_setting');
    $this->configuration['test_engine_suffix'] = $form_state
      ->getValue('test_engine_suffix');
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('test_engine_setting') === 'rejected') {
      $form_state
        ->setErrorByName('test_engine_setting', 'Setting has an invalid value');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'test_engine_setting' => '',
      'test_engine_suffix' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getError() {
  }

  /**
   * {@inheritdoc}
   */
  public function addPage($content) {
    $this->html = $content;
  }

  /**
   * {@inheritdoc}
   */
  public static function dependenciesAvailable() {
    return TRUE;
  }

}

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::$pdf protected property The PDF library object. 2
PdfEngineBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PdfEngineBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
PdfEngineBase::getInstallationInstructions public static function Gets the installation instructions for this PDF engine. Overrides PdfEngineInterface::getInstallationInstructions 2
PdfEngineBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
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.
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.
TestPdfEngine::$html protected property
TestPdfEngine::addPage public function Add a string of HTML to a new page. Overrides PdfEngineInterface::addPage
TestPdfEngine::buildConfigurationForm public function Form constructor. Overrides PdfEngineBase::buildConfigurationForm
TestPdfEngine::defaultConfiguration public function Gets default configuration for this plugin. Overrides PdfEngineBase::defaultConfiguration
TestPdfEngine::dependenciesAvailable public static function Checks if the PDF engine dependencies are available. Overrides PdfEngineInterface::dependenciesAvailable
TestPdfEngine::getError public function
TestPdfEngine::send public function Send the PDF contents to the browser. Overrides PdfEngineInterface::send
TestPdfEngine::submitConfigurationForm public function Form submission handler. Overrides PdfEngineBase::submitConfigurationForm
TestPdfEngine::validateConfigurationForm public function Form validation handler. Overrides PdfEngineBase::validateConfigurationForm
TestPdfEngine::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PdfEngineBase::__construct