Added an option to notify user when is getting a new certificate.

Author: atlet

classes/form/details.php

@@ -99,6 +99,10 @@ public function definition() {
         $mform->setDefault('maxissuances', 0);
         $mform->addHelpButton('maxissuances', 'maxissuances', 'tool_certificate');
 
+        $mform->addElement('advcheckbox', 'notify', get_string('notify', 'tool_certificate'));
+        $mform->addHelpButton('notify', 'notify', 'tool_certificate');
+        $mform->setDefault('notify', 1);
+
         if (!$this->get_template()->get_id()) {
             page::add_page_elements($mform);
         } else {
@@ -194,6 +198,7 @@ public function set_data_for_dynamic_submission(): void {
                 'shared' => $this->template->get_shared(),
                 'categoryid' => $this->template->get_category_id(),
                 'maxissuances' => $this->template->get_maxissuances(),
+                'notify' => $this->template->get_notify(),
             ]);
         } else {
             $data = template::instance()->new_page()->to_record();

classes/persistent/template.php

@@ -57,6 +57,9 @@ protected static function define_properties() {
             ],
             'maxissuances' => [
                 'type' => PARAM_INT,
+            ],
+            'notify' => [
+                'type' => PARAM_BOOL
             ]
         ];
     }

classes/template.php

@@ -88,6 +88,9 @@ public function save($data) {
         if (isset($data->maxissuances)) {
             $this->persistent->set('maxissuances', $data->maxissuances);
         }
+        if (isset($data->notify)) {
+            $this->persistent->set('notify', $data->notify);
+        }        
         $this->persistent->save();
         \tool_certificate\event\template_updated::create_from_template($this)->trigger();
     }
@@ -456,6 +459,15 @@ public function get_maxissuances() {
         return $this->persistent->get('maxissuances');
     }
 
+    /**
+     * Returns the notify setting of the template.
+     *
+     * @return string the shared setting of the template
+     */
+    public function get_notify() {
+        return $this->persistent->get('notify');
+    }    
+
     /**
      * Returns the formatted name of the template.
      *
@@ -661,6 +673,7 @@ public static function create($formdata) {
         $template->name = $formdata->name;
         $template->shared = $formdata->shared ?? 0;
         $template->maxissuances = $formdata->maxissuances ?? 0;
+        $template->notify = $formdata->notify ?? 1;        
         if (!isset($formdata->contextid)) {
             debugging('Context is missing', DEBUG_DEVELOPER);
             $template->contextid = \context_system::instance()->id;
@@ -712,6 +725,7 @@ public function issue_certificate($userid, $expires = null, array $data = [], $c
         component_class_callback(\tool_tenant\config::class, 'push_for_user', [$userid]);
 
         $maxissuances = $DB->get_field('tool_certificate_templates', 'maxissuances', array('id' => $this->get_id()));
+        $notify = (bool) $DB->get_field('tool_certificate_templates', 'notify', array('id' => $this->get_id()));
         $usercertificates = $DB->count_records('tool_certificate_issues', array('userid' => $userid, 'templateid' => $this->get_id()));
 
         if ($maxissuances > 0 && $usercertificates >= $maxissuances) {
@@ -749,7 +763,9 @@ public function issue_certificate($userid, $expires = null, array $data = [], $c
 
         // Create the issue file and send notification.
         $issuefile = $this->create_issue_file($issue);
-        self::send_issue_notification($issue, $issuefile);
+        if ($notify) {
+            self::send_issue_notification($issue, $issuefile);
+        }
 
         component_class_callback(\tool_tenant\config::class, 'pop', []);
 

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="admin/tool/certificate/db" VERSION="20240819" COMMENT="XMLDB file for Moodle tool_certificate"
+<XMLDB PATH="admin/tool/certificate/db" VERSION="20241004" COMMENT="XMLDB file for Moodle tool_certificate"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../../lib/xmldb/xmldb.xsd"
 >
@@ -13,6 +13,7 @@
         <FIELD NAME="timecreated" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="timemodified" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="maxissuances" TYPE="int" LENGTH="3" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="Maximum issuances per user. If 0 there is no limit."/>
+        <FIELD NAME="notify" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Notify user of new issued certificate."/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id" COMMENT="Primary key for certificate_template"/>

db/upgrade.php

@@ -279,5 +279,20 @@ function xmldb_tool_certificate_upgrade($oldversion) {
         upgrade_plugin_savepoint(true, 2024081902, 'tool', 'certificate');
     }
 
+    if ($oldversion < 2024100401) {
+
+        // Define field notify to be added to tool_certificate_templates.
+        $table = new xmldb_table('tool_certificate_templates');
+        $field = new xmldb_field('notify', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '1', 'maxissuances');
+
+        // Conditionally launch add field notify.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Certificate savepoint reached.
+        upgrade_plugin_savepoint(true, 2024100401, 'tool', 'certificate');
+    }
+
     return true;
 }

lang/en/tool_certificate.php

@@ -202,6 +202,8 @@
 $string['maxissuances'] = 'Maximum issuances per user';
 $string['maxissuances_help'] = 'The maximum number of times this certificate can be issued to a single user. If 0 there is no limit.';
 $string['maxissuancesreached'] = 'You have reached the maximum number of times this certificate can be issued to you.';
+$string['notify'] = 'Notify users';
+$string['notify_help'] = 'Notify users that they received a new certificate.';
 
 // Deprecated since 4.2.
 $string['editcertificate'] = 'Edit certificate template \'{$a}\'';

version.php

@@ -26,7 +26,7 @@
 
 $plugin->component    = 'tool_certificate';
 $plugin->release      = '4.4.3';
-$plugin->version      = 2024090300;
+$plugin->version      = 2024100401;
 $plugin->requires     = 2022041900.00;
 $plugin->maturity     = MATURITY_STABLE;
 $plugin->supported    = [400, 404];