class TestWordPrintEngine in Entity Print 8.2

The test word pring engine.

Plugin annotation

@PrintEngine(
  id = "test_word_print_engine",
  label = @Translation("Test Word Print Engine"),
  export_type = "word_docx"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_print\Plugin\PrintEngineBase implements ContainerFactoryPluginInterface, PrintEngineInterface
      • class \Drupal\entity_print_test\Plugin\EntityPrint\PrintEngine\TestWordPrintEngine

File

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

Namespace

Drupal\entity_print_test\Plugin\EntityPrint\PrintEngine

class TestWordPrintEngine extends PrintEngineBase {

  /**
   * The HTML string we're building.
   *
   * @var string
   */
  protected $html = '';

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

  /**
   * {@inheritdoc}
   */
  public function send($filename, $force_download = TRUE) {
    echo $filename;
    echo 'Using ' . $this
      ->getPluginId();
    echo $this->html;
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'test_word_setting' => 'my-default',
    ];
  }

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

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

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

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

}

Members

Name	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::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
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.
TestWordPrintEngine::$html	protected	property	The HTML string we're building.
TestWordPrintEngine::addPage	public	function	Add a string of HTML to a new page. Overrides PrintEngineInterface::addPage
TestWordPrintEngine::buildConfigurationForm	public	function	Form constructor. Overrides PrintEngineBase::buildConfigurationForm
TestWordPrintEngine::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides PrintEngineBase::defaultConfiguration
TestWordPrintEngine::dependenciesAvailable	public static	function	Checks if the Print engine dependencies are available. Overrides PrintEngineInterface::dependenciesAvailable
TestWordPrintEngine::getBlob	public	function	Gets the binary data for the printed document. Overrides PrintEngineInterface::getBlob
TestWordPrintEngine::getPrintObject	public	function	Gets the object for this Print engine. Overrides PrintEngineInterface::getPrintObject
TestWordPrintEngine::send	public	function	Send the Print contents to the browser. Overrides PrintEngineInterface::send
TestWordPrintEngine::submitConfigurationForm	public	function	Form submission handler. Overrides PrintEngineBase::submitConfigurationForm