You are here

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

class TestPrintEngine in Entity Print 8.2

A test print engine plugin.

Plugin annotation


@PrintEngine(
  id = "testprintengine",
  label = @Translation("Test Print Engine"),
  export_type = "pdf"
)

Hierarchy

Expanded class hierarchy of TestPrintEngine

File

tests/modules/entity_print_test/src/Plugin/EntityPrint/PrintEngine/TestPrintEngine.php, line 17

Namespace

Drupal\entity_print_test\Plugin\EntityPrint\PrintEngine
View source 
class TestPrintEngine extends PrintEngineBase {

  /**
   * The HTML string.
   *
   * @var string
   */
  protected $html;

  /**
   * {@inheritdoc}
   */
  public function send($filename, $force_download = TRUE) {
    echo $filename;

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

  /**
   * {@inheritdoc}
   */
  public function getBlob() {
    return 'Using testprintengine';
  }

  /**
   * {@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([
      'testprintengine',
      'test_engine_setting',
    ]);
    $this->configuration['test_engine_suffix'] = $form_state
      ->getValue([
      'testprintengine',
      'test_engine_suffix',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue([
      'testprintengine',
      '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;
  }

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

}

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::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::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 3
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.
TestPrintEngine::$html protected property The HTML string.
TestPrintEngine::addPage public function Add a string of HTML to a new page. Overrides PrintEngineInterface::addPage
TestPrintEngine::buildConfigurationForm public function Form constructor. Overrides PrintEngineBase::buildConfigurationForm
TestPrintEngine::defaultConfiguration public function Gets default configuration for this plugin. Overrides PrintEngineBase::defaultConfiguration
TestPrintEngine::dependenciesAvailable public static function Checks if the Print engine dependencies are available. Overrides PrintEngineInterface::dependenciesAvailable
TestPrintEngine::getBlob public function Gets the binary data for the printed document. Overrides PrintEngineInterface::getBlob
TestPrintEngine::getError public function
TestPrintEngine::getPrintObject public function Gets the object for this Print engine. Overrides PrintEngineInterface::getPrintObject
TestPrintEngine::send public function Send the Print contents to the browser. Overrides PrintEngineInterface::send
TestPrintEngine::submitConfigurationForm public function Form submission handler. Overrides PrintEngineBase::submitConfigurationForm
TestPrintEngine::validateConfigurationForm public function Form validation handler. Overrides PrintEngineBase::validateConfigurationForm