class TcPdfv1 in Entity Print 8.2

TCPDF plugin implementation.

@PrintEngine( id = "tcpdfv1", label = @Translation("TCPDF (v1)"), export_type = "pdf" )

To use this implementation you will need the TCPDF library, simply run


    composer require "tecnickcom/tcpdf ~6"

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\Plugin\EntityPrint\PrintEngine\TcPdfv1

Expanded class hierarchy of TcPdfv1

File

src/Plugin/EntityPrint/PrintEngine/TcPdfv1.php, line 24

Namespace

Drupal\entity_print\Plugin\EntityPrint\PrintEngine

View source

class TcPdfv1 extends PrintEngineBase {

  /**
   * The TCPDF implementation.
   *
   * @var \TCPDF
   */
  protected $tcpdf;

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

  /**
   * {@inheritdoc}
   */
  public static function getInstallationInstructions() {
    return t('Please install with: @command', [
      '@command' => 'composer require "tecnickcom/tcpdf ~6"',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'page_format' => 'A4',
      'orientation' => static::PORTRAIT,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $page_formats = array_combine(array_keys(\TCPDF_STATIC::$page_formats), array_keys(\TCPDF_STATIC::$page_formats));
    $form['page_format'] = [
      '#title' => $this
        ->t('Paper Size'),
      '#type' => 'select',
      '#options' => $page_formats,
      '#default_value' => $this->configuration['page_format'],
      '#description' => $this
        ->t('The page size to print the PDF to.'),
    ];
    $form['orientation'] = [
      '#title' => $this
        ->t('Paper Orientation'),
      '#type' => 'select',
      '#options' => [
        static::PORTRAIT => $this
          ->t('Portrait'),
        static::LANDSCAPE => $this
          ->t('Landscape'),
      ],
      '#default_value' => $this->configuration['orientation'],
      '#description' => $this
        ->t('The paper orientation one of Landscape or Portrait'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function addPage($content) {
    $this->tcpdf
      ->AddPage($this->configuration['orientation'], $this->configuration['page_format']);
    $this->tcpdf
      ->writeHTML($content);
  }

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

    // If we have a filename then we force the download otherwise we open in the
    // browser.
    $this->tcpdf
      ->Output($filename, $force_download ? 'D' : 'I');
  }

  /**
   * {@inheritdoc}
   */
  public function getBlob() {
    return $this->tcpdf
      ->Output('', 'S');
  }

  /**
   * {@inheritdoc}
   */
  public static function dependenciesAvailable() {
    return class_exists('\\TCPDF') && !drupal_valid_test_ua();
  }

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

}

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

You are here

class TcPdfv1 in Entity Print 8.2

Hierarchy

File

Namespace

Members

API Navigation