class PhpWkhtmlToPdf in Entity Print 8

@PdfEngine( id = "phpwkhtmltopdf", label = @Translation("Php Wkhtmltopdf") )

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

    composer require "mikehaertl/phpwkhtmltopdf ~2.1"

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_print\Plugin\PdfEngineBase implements PdfEngineInterface
      • class \Drupal\entity_print\Plugin\EntityPrint\PdfEngine\PhpWkhtmlToPdf

File

src/Plugin/EntityPrint/PdfEngine/PhpWkhtmlToPdf.php, line 22

Namespace

Drupal\entity_print\Plugin\EntityPrint\PdfEngine

class PhpWkhtmlToPdf extends PdfEngineBase {

  /**
   * @var \mikehaertl\wkhtmlto\Pdf
   */
  protected $pdf;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->pdf = new Pdf([
      'binary' => $this->configuration['binary_location'],
    ]);
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'binary_location' => '/usr/local/bin/wkhtmltopdf',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['binary_location'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Binary Location'),
      '#description' => $this
        ->t('Set this to the system path where the PDF engine binary is located.'),
      '#default_value' => $this->configuration['binary_location'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $binary_location = $form_state
      ->getValue('binary_location');
    if (!file_exists($binary_location)) {
      $form_state
        ->setErrorByName('binary_location', sprintf('The wkhtmltopdf binary does not exist at %s', $binary_location));
    }
  }

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

    // If the filename received here is NULL, force open in the browser
    // otherwise attempt to have it downloaded.
    if (!$this->pdf
      ->send($filename, (bool) $filename)) {
      throw new PdfEngineException(sprintf('Failed to generate PDF: %s', $this->pdf
        ->getError()));
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public static function dependenciesAvailable() {
    return class_exists('mikehaertl\\wkhtmlto\\Pdf');
  }

}

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