Paper size and orientation options for PR

BrowseImages.php

@@ -1,7 +1,7 @@
-<?php
-/**
- * Create instance of Custom Report Builder,
- * and display image gallery.
- */
-$customReportBuilder = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
-$customReportBuilder->browseImages();
+<?php
+/**
+ * Create instance of Custom Report Builder,
+ * and display image gallery.
+ */
+$customReportBuilder = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+$customReportBuilder->browseImages();

CreateTemplate.php

@@ -1,17 +1,17 @@
-<?php
-/**
- * Include REDCap header.
- */
-require_once APP_PATH_DOCROOT . "ProjectGeneral/header.php"; 
-
-/**
- * Initialize Custom Template Engine object, and call method
- * to generate Create Template page.
- */
-$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
-$customTemplateEngine->generateCreateEditTemplatePage();
-
-/**
- * Include REDCap footer.
- */
+<?php
+/**
+ * Include REDCap header.
+ */
+require_once APP_PATH_DOCROOT . "ProjectGeneral/header.php"; 
+
+/**
+ * Initialize Custom Template Engine object, and call method
+ * to generate Create Template page.
+ */
+$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+$customTemplateEngine->generateCreateEditTemplatePage();
+
+/**
+ * Include REDCap footer.
+ */
 require_once APP_PATH_DOCROOT . "ProjectGeneral/footer.php";

CustomTemplateEngine.php

@@ -1086,7 +1086,7 @@ public function saveTemplate()
      *
      * @since 3.1
      */
-    public function createPDF($dompdf_obj, $header, $footer, $main)
+    public function createPDF($dompdf_obj, $header, $footer, $main, $fileOrTemplateName="")
     {
         $contents = $this->formatPDFContents($header, $footer, $main);
 
@@ -1098,7 +1098,8 @@ public function createPDF($dompdf_obj, $header, $footer, $main)
         $dompdf_obj->set_option('isRemoteEnabled', TRUE);
 
         // Setup the paper size and orientation
-        $dompdf_obj->setPaper("letter", "portrait");
+        list($paperSize, $paperOrientation) = $this->getPaperSettings($fileOrTemplateName);
+        $dompdf_obj->setPaper($paperSize, $paperOrientation);
 
         // Render the HTML as PDF
         $dompdf_obj->render();
@@ -1130,7 +1131,7 @@ public function downloadTemplate()
         if (isset($main) && !empty($main))
         {
             $dompdf = new Dompdf();
-            $pdf_content = $this->createPDF($dompdf, $header, $footer, $main);
+            $pdf_content = $this->createPDF($dompdf, $header, $footer, $main, $filename);
 
             if (!$this->getProjectSetting("save-report-to-repo"))
             {
@@ -2847,4 +2848,30 @@ public function redcap_module_link_check_display($project_id, $link)
             return $link;
         }
     }
-}
+
+    /**
+     * getPaperSettings($name) 
+     * Look for module project setting with name corresponding to the tempalte or file name provided
+     * @param String $name Name of template or pdf document file name
+     * @return Array Array with two elements: 1. paper size e.g. "Letter", "A4"; 2: paper orientation "Portrait" or "Landscape""
+     */
+    protected function getPaperSettings($fileOrTemplateName) 
+    {
+        $paperSize = "letter";
+        $paperOrientation = "portrait";
+
+        $templateSettings = $this->getSubSettings('template-options');
+
+        foreach ($templateSettings as $settings) {
+            // look for a template with name occurring within the file name of what's being generated 
+            // (pretty horrid - will catch "MyTemplate" before "MyTemplate_New" - need better way of recording template names perhaps recording to project settings on create/save/delete and auto-generate template name for files system storage?)
+            if (strpos($fileOrTemplateName, $settings['template-name']) !== false) {
+                $paperSize = (empty($settings['option-paper-size'])) ? $paperSize : $settings['option-paper-size'];
+                $paperOrientation = ($settings['option-paper-orientation']) ? "landscape" : $paperOrientation;
+                break;
+            }
+        }
+
+        return array($paperSize, $paperOrientation);
+    }
+}

DeleteTemplate.php

@@ -1,20 +1,20 @@
-<?php
-/**
- * Initialize Custom Template Engine object, and call method to delete a
- * template.
- */
-$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
-$result = $customTemplateEngine->deleteTemplate();
-
-/**
- * If TRUE, then template was deleted successfullly and redirect to index with param deleted = 1.
- * Else, then template wasn't deleted successfully and redirect to index with param deleted = 0.
- */
-if ($result === TRUE)
-{
-    header("Location:" . $customTemplateEngine->getUrl("index.php") . "&deleted=1");
-}
-else
-{
-    header("Location:" . $customTemplateEngine->getUrl("index.php") . "&deleted=0");
+<?php
+/**
+ * Initialize Custom Template Engine object, and call method to delete a
+ * template.
+ */
+$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+$result = $customTemplateEngine->deleteTemplate();
+
+/**
+ * If TRUE, then template was deleted successfullly and redirect to index with param deleted = 1.
+ * Else, then template wasn't deleted successfully and redirect to index with param deleted = 0.
+ */
+if ($result === TRUE)
+{
+    header("Location:" . $customTemplateEngine->getUrl("index.php") . "&deleted=1");
+}
+else
+{
+    header("Location:" . $customTemplateEngine->getUrl("index.php") . "&deleted=0");
 }

DownloadFilledTemplate.php

@@ -1,6 +1,6 @@
-<?php
-/**
- * Initialize Custom Template Engine object, and call method to download template.
- */
-$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+<?php
+/**
+ * Initialize Custom Template Engine object, and call method to download template.
+ */
+$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
 $customTemplateEngine->downloadTemplate();

EditTemplate.php

@@ -1,18 +1,18 @@
-<?php
-/**
- * Include REDCap header.
- */
-require_once APP_PATH_DOCROOT . "ProjectGeneral/header.php";
-
-/**
- * Inititalize Custom Template Engine object and display Edit Template
- * page.
- */
-$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
-$template_filtered = filter_input(INPUT_POST, 'template', FILTER_SANITIZE_SPECIAL_CHARS);
-$customTemplateEngine->generateCreateEditTemplatePage($template_filtered);
-
-/**
- * Include REDCap footer.
- */
-require_once APP_PATH_DOCROOT . "ProjectGeneral/footer.php";
+<?php
+/**
+ * Include REDCap header.
+ */
+require_once APP_PATH_DOCROOT . "ProjectGeneral/header.php";
+
+/**
+ * Inititalize Custom Template Engine object and display Edit Template
+ * page.
+ */
+$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+$template_filtered = filter_input(INPUT_POST, 'template', FILTER_SANITIZE_SPECIAL_CHARS);
+$customTemplateEngine->generateCreateEditTemplatePage($template_filtered);
+
+/**
+ * Include REDCap footer.
+ */
+require_once APP_PATH_DOCROOT . "ProjectGeneral/footer.php";

FillAndSave.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * REDCap External Module: Custom Template Engine
+ * @author Luke Stevens lukestevens@hotmail.com https://github.com/lsgs/ 
+ */
+if (is_null($module) || !($module instanceof MCRI\CustomTemplateEngine\CustomTemplateEngine)) { exit(); }
+header("Content-Type: application/json");
+echo \json_encode($module->fillAndSave());

FillTemplate.php

@@ -1,27 +1,27 @@
-<?php
-
-/**
- * Create instsance of Custom Template Engine, and display template 
- * filled with REDcap data on Fill Template page.
- */
-$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
-
-if ($_POST["participantID"] == null) { exit(1);}  // PHP8 compatability fix; can't pass a blank participantID scalar. Dan Evans 2023-06-09
-if (sizeof($_POST["participantID"]) == 1)
-{
-    /**
-     * Include REDCap header.
-     */
-    require_once APP_PATH_DOCROOT . "ProjectGeneral/header.php";
-
-    $customTemplateEngine->generateFillTemplatePage();
-
-    /**
-     * Include REDCap footer.
-     */
-    require_once APP_PATH_DOCROOT . "ProjectGeneral/footer.php";
-}
-else
-{
-    $customTemplateEngine->batchFillReports();
-}
+<?php
+
+/**
+ * Create instsance of Custom Template Engine, and display template 
+ * filled with REDcap data on Fill Template page.
+ */
+$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+
+if ($_POST["participantID"] == null) { exit(1);}  // PHP8 compatability fix; can't pass a blank participantID scalar. Dan Evans 2023-06-09
+if (sizeof($_POST["participantID"]) == 1)
+{
+    /**
+     * Include REDCap header.
+     */
+    require_once APP_PATH_DOCROOT . "ProjectGeneral/header.php";
+
+    $customTemplateEngine->generateFillTemplatePage();
+
+    /**
+     * Include REDCap footer.
+     */
+    require_once APP_PATH_DOCROOT . "ProjectGeneral/footer.php";
+}
+else
+{
+    $customTemplateEngine->batchFillReports();
+}

README.md

@@ -18,6 +18,7 @@ When switching from the old module to the rebranded module, you must disable the
 
 ## Project Configurations
 - Save Filled Templates to File Repository: This is specific to downloading a filled template, and will save a copy of the PDF to the File Repository. 
+- [Optional] Enter templates by name and specify an alternative paper size, e.g. A4 (default is Letter), and/or select landscape orientation.
 
 ## Permissions
 
@@ -68,5 +69,4 @@ WARNING:  This module is not currently able to support REDCap instances using lo
   * upgraded included Javascript libraries:
     * ckeditor to latest v4.21
     * dompdf to latest v2.0
-    * smarty to latest v4.1
-
+    * smarty to latest v4.1

SaveFileToField.php

@@ -63,7 +63,7 @@
     }
 
     $dompdf = new Dompdf();
-    $pdf_content = $customTemplateEngine->createPDF($dompdf, $header, $footer, $main);
+    $pdf_content = $customTemplateEngine->createPDF($dompdf, $header, $footer, $main, $filename);
 
     if (!$customTemplateEngine->saveFileToField($filename, $pdf_content, $field_name, $record, $event_id))
     {

SaveTemplate.php

@@ -1,8 +1,8 @@
-<?php
-/**
- * Create an instance of the Custom Template Engine class,
- * and save template.
- */
-$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
-$result = $customTemplateEngine->saveTemplate();
+<?php
+/**
+ * Create an instance of the Custom Template Engine class,
+ * and save template.
+ */
+$customTemplateEngine = new \BCCHR\CustomTemplateEngine\CustomTemplateEngine();
+$result = $customTemplateEngine->saveTemplate();
 print json_encode($result);