class LocalServerPdfBackend in FillPDF 8.4

Same name and namespace in other branches

5.0.x src/Plugin/PdfBackend/LocalServerPdfBackend.php \Drupal\fillpdf\Plugin\PdfBackend\LocalServerPdfBackend

LocalServer PdfBackend plugin.

Plugin annotation


@PdfBackend(
  id = "local_service",
  label = @Translation("FillPDF LocalServer"),
  description = @Translation("Network-accessible, self-installed PDF API. You will need a VPS or dedicated server."),
  weight = 5
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\fillpdf\Plugin\PdfBackendBase implements PdfBackendInterface
    class \Drupal\fillpdf\Plugin\PdfBackend\LocalServerPdfBackend implements ContainerFactoryPluginInterface, FillPdfBackendPluginInterface

Expanded class hierarchy of LocalServerPdfBackend

File

src/Plugin/PdfBackend/LocalServerPdfBackend.php, line 27

Namespace

Drupal\fillpdf\Plugin\PdfBackend

View source

class LocalServerPdfBackend extends PdfBackendBase implements ContainerFactoryPluginInterface, FillPdfBackendPluginInterface {

  /**
   * The file system.
   *
   * @var \Drupal\Core\File\FileSystem
   */
  protected $fileSystem;

  /**
   * The Guzzle http client.
   *
   * @var \GuzzleHttp\Client
   */
  protected $httpClient;

  /**
   * Constructs a LocalServerPdfBackend plugin object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \GuzzleHttp\Client $http_client
   *   The Guzzle http client.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, Client $http_client) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->httpClient = $http_client;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('http_client'));
  }

  /**
   * {@inheritdoc}
   *
   * @deprecated in fillpdf:8.x-4.9 and is removed from fillpdf:8.x-5.0.
   *   Instead use PdfBackendInterface::parseFile().
   * @see https://www.drupal.org/node/3059476
   * @see \Drupal\fillpdf\Plugin\PdfBackendInterface::parseFile()
   */
  public function parse(FillPdfFormInterface $fillpdf_form) {
    $template_file = File::load($fillpdf_form->file->target_id);
    return $this
      ->parseFile($template_file);
  }

  /**
   * {@inheritdoc}
   */
  public function parseFile(FileInterface $template_file) {
    $pdf_content = file_get_contents($template_file
      ->getFileUri());
    return $this
      ->parseStream($pdf_content);
  }

  /**
   * {@inheritdoc}
   */
  public function parseStream($pdf_content) {
    $request = [
      'pdf' => base64_encode($pdf_content),
    ];
    $json = \GuzzleHttp\json_encode($request);
    $fields = [];
    try {
      $fields_response = $this->httpClient
        ->post($this->configuration['local_service_endpoint'] . '/api/v1/parse', [
        'body' => $json,
        'headers' => [
          'Content-Type' => 'application/json',
        ],
      ]);
    } catch (RequestException $request_exception) {
      if ($response = $request_exception
        ->getResponse()) {
        \Drupal::messenger()
          ->addError($this
          ->t('Error %code. Reason: %reason.', [
          '%code' => $response
            ->getStatusCode(),
          '%reason' => $response
            ->getReasonPhrase(),
        ]));
      }
      else {
        \Drupal::messenger()
          ->addError($this
          ->t('Unknown error occurred parsing PDF.'));
      }
    }
    $fields = \GuzzleHttp\json_decode((string) $fields_response
      ->getBody(), TRUE);
    return $fields;
  }

  /**
   * {@inheritdoc}
   *
   * @deprecated in fillpdf:8.x-4.9 and is removed from fillpdf:8.x-5.0.
   *   Instead use PdfBackendInterface::mergeFile().
   *
   * @see https://www.drupal.org/node/3059476
   * @see \Drupal\fillpdf\Plugin\PdfBackendInterface::mergeFile()
   */
  public function populateWithFieldData(FillPdfFormInterface $fillpdf_form, array $field_mapping, array $context) {
    $template_file = File::load($fillpdf_form->file->target_id);
    return $this
      ->mergeFile($template_file, $field_mapping, $context);
  }

  /**
   * {@inheritdoc}
   */
  public function mergeFile(FileInterface $template_file, array $field_mappings, array $context) {
    $pdf_content = file_get_contents($template_file
      ->getFileUri());
    return $this
      ->mergeStream($pdf_content, $field_mappings, $context);
  }

  /**
   * {@inheritdoc}
   */
  public function mergeStream($pdf_content, array $field_mappings, array $context) {
    $flatten = $context['flatten'];
    $api_fields = [];
    foreach ($field_mappings as $key => $mapping) {
      $api_field = NULL;
      if ($mapping instanceof TextFieldMapping) {
        $api_field = [
          'type' => 'text',
          'data' => $mapping
            ->getData(),
        ];
      }
      elseif ($mapping instanceof ImageFieldMapping) {
        $api_field = [
          'type' => 'image',
          'data' => base64_encode($mapping
            ->getData()),
        ];
        if ($extension = $mapping
          ->getExtension()) {
          $api_field['extension'] = $extension;
        }
      }
      if ($api_field) {
        $api_fields[$key] = $api_field;
      }
    }
    $request = [
      'pdf' => base64_encode($pdf_content),
      'flatten' => $flatten,
      'fields' => $api_fields,
    ];
    $json = \GuzzleHttp\json_encode($request);
    try {
      $response = $this->httpClient
        ->post($this->configuration['local_service_endpoint'] . '/api/v1/merge', [
        'body' => $json,
        'headers' => [
          'Content-Type' => 'application/json',
        ],
      ]);
      $decoded = \GuzzleHttp\json_decode((string) $response
        ->getBody(), TRUE);
      return base64_decode($decoded['pdf']);
    } catch (RequestException $e) {
      watchdog_exception('fillpdf', $e);
      return NULL;
    }
  }

}

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
LocalServerPdfBackend::$fileSystem	protected	property	The file system.
LocalServerPdfBackend::$httpClient	protected	property	The Guzzle http client.
LocalServerPdfBackend::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LocalServerPdfBackend::mergeFile	public	function	Populate a PDF file with field data. Overrides PdfBackendInterface::mergeFile
LocalServerPdfBackend::mergeStream	public	function	Populate a PDF file with field data. Overrides PdfBackendInterface::mergeStream
LocalServerPdfBackend::parse Deprecated	public	function	Overrides FillPdfBackendPluginInterface::parse
LocalServerPdfBackend::parseFile	public	function	Parse a PDF and return a list of its fields. Overrides PdfBackendInterface::parseFile
LocalServerPdfBackend::parseStream	public	function	Parse a PDF and return a list of its fields. Overrides PdfBackendInterface::parseStream
LocalServerPdfBackend::populateWithFieldData Deprecated	public	function	Overrides FillPdfBackendPluginInterface::populateWithFieldData
LocalServerPdfBackend::__construct	public	function	Constructs a LocalServerPdfBackend plugin object. Overrides PluginBase::__construct
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.
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.

You are here

class LocalServerPdfBackend in FillPDF 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation