Add expiry dates to recipient list, verify (#499)

Add a new element, customcertelement_expiry, which represents the
certificate's expiry date, 1-5 years from either the award date or the
course completion date.  This date is shown in the recipients table
shown to the teacher and the verify page when this element is added to
a certificate.

Author: leonstr

classes/output/verify_certificate_result.php

@@ -61,6 +61,11 @@ class verify_certificate_result implements templatable, renderable {
      */
     public $certificatename;
 
+    /**
+     * @var int The certificate's expiry date (optional).
+     */
+    public $expiry;
+
     /**
      * Constructor.
      *
@@ -76,6 +81,12 @@ public function __construct($result) {
         $this->courseurl = new \moodle_url('/course/view.php', ['id' => $result->courseid]);
         $this->coursefullname = format_string($result->coursefullname, true, ['context' => $context]);
         $this->certificatename = format_string($result->certificatename, true, ['context' => $context]);
+
+        if (property_exists($result, 'expiry')) {
+            $this->expiry = $result->expiry;
+        } else {
+            $this->expiry = null;
+        }
     }
 
     /**
@@ -92,6 +103,10 @@ public function export_for_template(\renderer_base $output) {
         $result->courseurl = $this->courseurl;
         $result->certificatename = $this->certificatename;
 
+        if (!empty($this->expiry)) {
+            $result->expiry = $this->expiry;
+        }
+
         return $result;
     }
 }

classes/report_table.php

@@ -24,6 +24,8 @@
 
 namespace mod_customcert;
 
+use \customcertelement_expiry\element as expiry_element;
+
 defined('MOODLE_INTERNAL') || die;
 
 global $CFG;
@@ -67,13 +69,23 @@ public function __construct($customcertid, $cm, $groupmode, $download = null) {
 
         $context = \context_module::instance($cm->id);
         $extrafields = \core_user\fields::for_identity($context)->get_required_fields();
+        $showexpiry = false;
+
+        if (class_exists('\customcertelement_expiry\element')) {
+            $showexpiry = expiry_element::has_expiry($customcertid);
+        }
 
         $columns = [];
         $columns[] = 'fullname';
         foreach ($extrafields as $extrafield) {
             $columns[] = $extrafield;
         }
         $columns[] = 'timecreated';
+
+        if ($showexpiry) {
+            $columns[] = 'timeexpires';
+        }
+
         $columns[] = 'code';
 
         $headers = [];
@@ -82,6 +94,11 @@ public function __construct($customcertid, $cm, $groupmode, $download = null) {
             $headers[] = \core_user\fields::get_display_name($extrafield);
         }
         $headers[] = get_string('receiveddate', 'customcert');
+
+        if ($showexpiry) {
+            $headers[] = get_string('expireson', 'customcertelement_expiry');
+        }
+
         $headers[] = get_string('code', 'customcert');
 
         // Check if we were passed a filename, which means we want to download it.
@@ -142,6 +159,20 @@ public function col_timecreated($user) {
         return userdate($user->timecreated, $format);
     }
 
+    /**
+     * Generate the optional certificate expires time column.
+     *
+     * @param \stdClass $user
+     * @return string
+     */
+    public function col_timeexpires($user) {
+        if ($this->is_downloading() === '') {
+            return expiry_element::get_expiry_html($this->customcertid, $user->id);
+        }
+        $format = '%Y-%m-%d %H:%M';
+        return userdate(expiry_element::get_expiry_date($this->customcertid, $user->id), $format);
+    }
+
     /**
      * Generate the code column.
      *
@@ -223,4 +254,3 @@ public function download() {
         exit;
     }
 }
-

db/upgrade.php

@@ -267,5 +267,24 @@ function xmldb_customcert_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2024042202, 'customcert');
     }
 
+    if ($oldversion < 2024042203) {
+        $elements = $DB->get_records('customcert_elements', ['element' => 'date']);
+
+        foreach ($elements as $element) {
+            $data = json_decode($element->data);
+
+            // If dateitem is between CUSTOMCERT_DATE_EXPIRY_ONE and CUSTOMCERT_DATE_EXPIRY_FIVE.
+            if ((intval($data->dateitem) <= -8) && (intval($data->dateitem) >= -12)) {
+                $data->startfrom = 'award';
+                $element->data = json_encode($data);
+                $element->element = 'expiry';
+                $DB->update_record('customcert_elements', $element);
+            }
+        }
+
+        // Customcert savepoint reached.
+        upgrade_mod_savepoint(true, 2024042203, 'customcert');
+    }
+
     return true;
 }

element/date/classes/element.php

@@ -66,31 +66,6 @@
  */
 define('CUSTOMCERT_DATE_ENROLMENT_END', '-7');
 
-/**
- * Date - Relative expiry date of 1 year
- */
-define('CUSTOMCERT_DATE_EXPIRY_ONE', '-8');
-
-/**
- * Date - Relative expiry date of 2 year
- */
-define('CUSTOMCERT_DATE_EXPIRY_TWO', '-9');
-
-/**
- * Date - Relative expiry date of 3 year
- */
-define('CUSTOMCERT_DATE_EXPIRY_THREE', '-10');
-
-/**
- * Date - Relative expiry date of 4 year
- */
-define('CUSTOMCERT_DATE_EXPIRY_FOUR', '-11');
-
-/**
- * Date - Relative expiry date of 5 year
- */
-define('CUSTOMCERT_DATE_EXPIRY_FIVE', '-12');
-
 require_once($CFG->dirroot . '/lib/grade/constants.php');
 
 /**
@@ -120,11 +95,6 @@ public function render_form_elements($mform) {
         }
         $dateoptions[CUSTOMCERT_DATE_ENROLMENT_START] = get_string('enrolmentstartdate', 'customcertelement_date');
         $dateoptions[CUSTOMCERT_DATE_ENROLMENT_END] = get_string('enrolmentenddate', 'customcertelement_date');
-        $dateoptions[CUSTOMCERT_DATE_EXPIRY_ONE] = get_string('expirydateone', 'customcertelement_date');
-        $dateoptions[CUSTOMCERT_DATE_EXPIRY_TWO] = get_string('expirydatetwo', 'customcertelement_date');
-        $dateoptions[CUSTOMCERT_DATE_EXPIRY_THREE] = get_string('expirydatethree', 'customcertelement_date');
-        $dateoptions[CUSTOMCERT_DATE_EXPIRY_FOUR] = get_string('expirydatefour', 'customcertelement_date');
-        $dateoptions[CUSTOMCERT_DATE_EXPIRY_FIVE] = get_string('expirydatefive', 'customcertelement_date');
         $dateoptions[CUSTOMCERT_DATE_COURSE_START] = get_string('coursestartdate', 'customcertelement_date');
         $dateoptions[CUSTOMCERT_DATE_COURSE_END] = get_string('courseenddate', 'customcertelement_date');
         $dateoptions[CUSTOMCERT_DATE_COURSE_GRADE] = get_string('coursegradedate', 'customcertelement_date');
@@ -193,16 +163,6 @@ public function render($pdf, $preview, $user) {
 
             if ($dateitem == CUSTOMCERT_DATE_ISSUE) {
                 $date = $issue->timecreated;
-            } else if ($dateitem == CUSTOMCERT_DATE_EXPIRY_ONE) {
-                $date = strtotime('+1 years', $issue->timecreated);
-            } else if ($dateitem == CUSTOMCERT_DATE_EXPIRY_TWO) {
-                $date = strtotime('+2 years', $issue->timecreated);
-            } else if ($dateitem == CUSTOMCERT_DATE_EXPIRY_THREE) {
-                $date = strtotime('+3 years', $issue->timecreated);
-            } else if ($dateitem == CUSTOMCERT_DATE_EXPIRY_FOUR) {
-                $date = strtotime('+4 years', $issue->timecreated);
-            } else if ($dateitem == CUSTOMCERT_DATE_EXPIRY_FIVE) {
-                $date = strtotime('+5 years', $issue->timecreated);
             } else if ($dateitem == CUSTOMCERT_DATE_CURRENT_DATE) {
                 $date = time();
             } else if ($dateitem == CUSTOMCERT_DATE_COMPLETION) {

element/date/lang/en/customcertelement_date.php

@@ -33,11 +33,6 @@
 $string['dateitem_help'] = 'This will be the date that is printed on the certificate';
 $string['enrolmentenddate'] = 'Enrolment end date';
 $string['enrolmentstartdate'] = 'Enrolment start date';
-$string['expirydatefive'] = 'Expiry date (5 year)';
-$string['expirydatefour'] = 'Expiry date (4 year)';
-$string['expirydateone'] = 'Expiry date (1 year)';
-$string['expirydatethree'] = 'Expiry date (3 year)';
-$string['expirydatetwo'] = 'Expiry date (2 year)';
 $string['issueddate'] = 'Issued date';
 $string['numbersuffix_nd_as_in_second'] = 'nd';
 $string['numbersuffix_rd_as_in_third'] = 'rd';