abstract class PrintEngineBase in Entity Print 8.2
The PrintEngineBase class.
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\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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
File
- src/
Plugin/ PrintEngineBase.php, line 14
Namespace
Drupal\entity_print\PluginView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PrintEngineBase:: |
protected | property | The export type plugin. | |
PrintEngineBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
4 |
PrintEngineBase:: |
public | function | ||
PrintEngineBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
1 |
PrintEngineBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
4 |
PrintEngineBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
PrintEngineBase:: |
public | function |
Gets the export type. Overrides PrintEngineInterface:: |
|
PrintEngineBase:: |
public static | function |
Gets the installation instructions for this Print engine. Overrides PrintEngineInterface:: |
3 |
PrintEngineBase:: |
constant | |||
PrintEngineBase:: |
constant | |||
PrintEngineBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
PrintEngineBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
2 |
PrintEngineBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
2 |
PrintEngineBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
3 |
PrintEngineInterface:: |
public | function | Add a string of HTML to a new page. | 7 |
PrintEngineInterface:: |
public static | function | Checks if the Print engine dependencies are available. | 7 |
PrintEngineInterface:: |
public | function | Gets the binary data for the printed document. | 7 |
PrintEngineInterface:: |
public | function | Gets the object for this Print engine. | 7 |
PrintEngineInterface:: |
public | function | Send the Print contents to the browser. | 7 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |