You are here

InputHelperInterface.php in FillPDF 5.0.x

Same filename and directory in other branches
  1. 8.4 src/InputHelperInterface.php

Namespace

Drupal\fillpdf

File

src/InputHelperInterface.php
View source
<?php

namespace Drupal\fillpdf;

use Drupal\file\FileInterface;

/**
 * Interface InputHelperInterface.
 *
 * @package Drupal\fillpdf
 */
interface InputHelperInterface {

  /**
   * Attaches a PDF template file to a FillPdfForm.
   *
   * @param \Drupal\file\FileInterface $file
   *   The PDF template file to attach.
   * @param \Drupal\fillpdf\FillPdfFormInterface $existing_form
   *   The FillPdfForm the PDF template file should be attached to.
   *
   * @return array
   *   Associative array with the following keys:
   *   - 'form': The updated FillPdfForm entity.
   *   - 'fields': Associative array of the FillPdfForm entity's saved
   *     FillPdfFormFields.
   */
  public function attachPdfToForm(FileInterface $file, FillPdfFormInterface $existing_form = NULL);

}

Interfaces

Namesort descending Description
InputHelperInterface Interface InputHelperInterface.