From b203fb0cfea9c54eeba397d170d4d0c820804fd6 Mon Sep 17 00:00:00 2001
From: Liam Morland <lkmorlan@uwaterloo.ca>
Date: Wed, 30 Mar 2022 12:16:58 -0400
Subject: [PATCH] Issue #3272528: API change: Rename token_objects to entities

---
 src/Controller/HandlePdfController.php | 4 +---
 src/OutputHandler.php                  | 4 +---
 src/OutputHandlerInterface.php         | 5 +----
 3 files changed, 3 insertions(+), 10 deletions(-)

diff --git a/src/Controller/HandlePdfController.php b/src/Controller/HandlePdfController.php
index f6956d8..2b43a5e 100644
--- a/src/Controller/HandlePdfController.php
+++ b/src/Controller/HandlePdfController.php
@@ -266,12 +266,10 @@ class HandlePdfController extends ControllerBase {
     // is separately available anyway.
     $context['filename'] = $filename;
 
-    // @todo Rename 'token_objects' to 'entities' in FillPDF 5.x. Webform
-    // submissions are now entities, too.
     $action_configuration = [
       'form' => $fillpdf_form,
       'context' => $context,
-      'token_objects' => $entities,
+      'entities' => $entities,
       'data' => $pdf_data,
       'filename' => $filename,
     ];
diff --git a/src/OutputHandler.php b/src/OutputHandler.php
index 36bc821..a0282cf 100644
--- a/src/OutputHandler.php
+++ b/src/OutputHandler.php
@@ -72,10 +72,8 @@ class OutputHandler implements OutputHandlerInterface {
     /** @var \Drupal\fillpdf\Entity\FillPdfForm $fillpdf_form */
     $fillpdf_form = $configuration['form'];
 
-    // @todo Rename 'token_objects' to 'entities' in FillPDF 5.x. Webform
-    // submissions are now entities, too.
     /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
-    $entities = $configuration['token_objects'];
+    $entities = $configuration['entities'];
 
     $destination_path = 'fillpdf';
     if (!empty($destination_path_override)) {
diff --git a/src/OutputHandlerInterface.php b/src/OutputHandlerInterface.php
index b691b07..95c0e24 100644
--- a/src/OutputHandlerInterface.php
+++ b/src/OutputHandlerInterface.php
@@ -19,7 +19,7 @@ interface OutputHandlerInterface {
    *     form: The FillPdfForm object from which the PDF was generated.
    *     context: The FillPDF request context as returned by
    *       FillPdfLinkManipulatorInterface::parseLink().
-   *     token_objects: The token data from which the PDF was generated.
+   *     entities: The entities from which the PDF was generated.
    *     data: The populated PDF data itself.
    *     filename: The filename (not including path) with which
    *       the PDF should be presented.
@@ -32,9 +32,6 @@ interface OutputHandlerInterface {
    *
    * @see \Drupal\fillpdf\FillPdfLinkManipulatorInterface::parseLink()
    * @see \Drupal\fillpdf\Plugin\FillPdfActionPlugin\FillPdfSaveAction::savePdf()
-   *
-   * @todo Rename 'token_objects' to 'entities' in FillPDF 5.x. Webform
-   *   submissions are now entities, too.
    */
   public function savePdfToFile(array $configuration, $destination_path_override = NULL);
 
-- 
GitLab