interface InvoicePrintBuilderInterface in Commerce Invoice 8.2

Handles generating PDFS for invoices.

Hierarchy

• interface \Drupal\commerce_invoice\InvoicePrintBuilderInterface

File

src/InvoicePrintBuilderInterface.php, line 11

Namespace

Drupal\commerce_invoice

interface InvoicePrintBuilderInterface {

  /**
   * Generates a filename for the given invoice.
   *
   * @param \Drupal\commerce_invoice\Entity\InvoiceInterface $invoice
   *   The invoice.
   *
   * @return string
   *   The generated filename.
   */
  public function generateFilename(InvoiceInterface $invoice);

  /**
   * Renders the invoice as a printed document and save to disk.
   *
   * @param \Drupal\commerce_invoice\Entity\InvoiceInterface $invoice
   *   The invoice.
   * @param \Drupal\entity_print\Plugin\PrintEngineInterface $print_engine
   *   The print engine plugin to use.
   * @param string $scheme
   *   (optional) The Drupal scheme, defaults to 'private'.
   *
   * @return \Drupal\file\FileInterface|null
   *   The invoice PDF file, FALSE it could not be created.
   */
  public function savePrintable(InvoiceInterface $invoice, PrintEngineInterface $print_engine, $scheme = 'private');

}

Members

Name	Modifiers	Type	Description	Overrides
InvoicePrintBuilderInterface::generateFilename	public	function	Generates a filename for the given invoice.	1
InvoicePrintBuilderInterface::savePrintable	public	function	Renders the invoice as a printed document and save to disk.	1