class InputHelper in FillPDF 5.0.x

Class InputHelper.

@package Drupal\fillpdf

Hierarchy

• class \Drupal\fillpdf\InputHelper implements InputHelperInterface

1 string reference to 'InputHelper'

fillpdf.services.yml in ./fillpdf.services.yml

fillpdf.services.yml

1 service uses InputHelper

fillpdf.input_helper in ./fillpdf.services.yml

Drupal\fillpdf\InputHelper

File

src/InputHelper.php, line 17

Namespace

Drupal\fillpdf

class InputHelper implements InputHelperInterface {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configManager;

  /**
   * The FillPDF backend manager.
   *
   * @var \Drupal\fillpdf\Plugin\PdfBackendManager
   */
  protected $backendManager;

  /**
   * Constructs an InputHelper object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\fillpdf\Plugin\PdfBackendManager $backend_manager
   *   The FillPDF backend manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, PdfBackendManager $backend_manager) {
    $this->configManager = $config_factory;
    $this->backendManager = $backend_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function attachPdfToForm(FileInterface $file, FillPdfFormInterface $existing_form = NULL) {

    // Save the file so we can get an fid.
    $file
      ->setPermanent();
    $file
      ->save();
    if ($existing_form) {
      $fillpdf_form = $existing_form;
      $fillpdf_form->file = $file;
    }
    else {
      $fillpdf_form = FillPdfForm::create([
        'file' => $file,
        'title' => $file->filename,
      ]);
    }

    // Save PDF configuration before parsing.
    $fillpdf_form
      ->save();

    // Parse and save fields.
    $form_fields = $this
      ->parseFields($fillpdf_form);
    foreach ($form_fields as $field) {
      $field
        ->save();
    }
    return [
      'form' => $fillpdf_form,
      'fields' => $form_fields,
    ];
  }

  /**
   * Parses fields of a FillPDF form.
   *
   * @param \Drupal\fillpdf\FillPdfFormInterface $fillpdf_form
   *   The FillPdfForm the PDF template file should be attached to.
   *
   * @return \Drupal\fillpdf\FillPdfFormFieldInterface[]
   *   Associative array of FillPdfFormField objects keyed by the PDF key.
   */
  public function parseFields(FillPdfFormInterface $fillpdf_form) {
    $config = $this->configManager
      ->get('fillpdf.settings');

    /** @var \Drupal\fillpdf\Plugin\PdfBackendInterface $backend */
    $backend = $this->backendManager
      ->createInstance($config
      ->get('backend'), $config
      ->get());

    // Attempt to parse the fields in the PDF.
    $parsed_fields = $backend
      ->parseFile(File::load($fillpdf_form->file->target_id));
    $unique_fields = [];
    foreach ((array) $parsed_fields as $field) {

      // Don't store "container" fields.
      if ($field['type']) {

        // Use the field name as key, so to consolidate duplicate fields.
        $unique_fields[$field['name']] = TRUE;
      }
    }

    // Create a FillPdfFormField object for each unique field.
    $form_fields = [];
    foreach (array_keys($unique_fields) as $pdf_key) {
      $form_fields[$pdf_key] = FillPdfFormField::create([
        'fillpdf_form' => $fillpdf_form,
        'pdf_key' => $pdf_key,
        'value' => '',
      ]);
    }
    return $form_fields;
  }

  /**
   * Saves an uploaded file, marking it permanent.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file object to save.
   *
   * @deprecated in fillpdf:8.x-4.7 and is removed from fillpdf:8.x-5.0.
   *   Use FileInterface::setPermanent() and FileInterface::save() instead.
   * @see https://www.drupal.org/project/fillpdf/issues/3055123
   * @see \Drupal\file\FileInterface
   */
  protected function saveFileUpload(FileInterface $file) {
    @trigger_error('InputHelper::saveFileUpload() is deprecated in fillpdf:8.x-4.7 and is removed from fillpdf:8.x-5.0. Use \\Drupal\\file\\FileInterface::setPermanent() and \\Drupal\\file\\FileInterface::save() instead. See https://www.drupal.org/project/fillpdf/issues/3055123', E_USER_DEPRECATED);
    $file
      ->setPermanent();
    $file
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
InputHelper::$backendManager	protected	property	The FillPDF backend manager.
InputHelper::$configManager	protected	property	The config factory.
InputHelper::attachPdfToForm	public	function	Attaches a PDF template file to a FillPdfForm. Overrides InputHelperInterface::attachPdfToForm
InputHelper::parseFields	public	function	Parses fields of a FillPDF form.
InputHelper::saveFileUpload Deprecated	protected	function	Saves an uploaded file, marking it permanent.
InputHelper::__construct	public	function	Constructs an InputHelper object.