Fix local_codechecker complaints

Author: mdjnelson

element/coursefield/lang/en/customcertelement_coursefield.php

@@ -23,7 +23,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-$string['pluginname'] = 'Course field';
-$string['privacy:metadata'] = 'The course field plugin does not store any personal data.';
 $string['coursefield'] = 'Course field';
 $string['coursefield_help'] = 'This is the course field that will be displayed on the PDF.';
+$string['pluginname'] = 'Course field';
+$string['privacy:metadata'] = 'The course field plugin does not store any personal data.';

element/coursename/lang/en/customcertelement_coursename.php

@@ -22,10 +22,9 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+$string['coursefullname'] = 'Full name';
 $string['coursenamedisplay'] = 'Type';
 $string['coursenamedisplay_help'] = 'Display the course full name or short name?';
-$string['coursefullname'] = 'Full name';
 $string['courseshortname'] = 'Short name';
 $string['pluginname'] = 'Course name';
 $string['privacy:metadata'] = 'The Course name plugin does not store any personal data.';
-

element/date/lang/en/customcertelement_date.php

@@ -26,22 +26,22 @@
 $string['courseenddate'] = 'Course end date';
 $string['coursegradedate'] = 'Course grade date';
 $string['coursestartdate'] = 'Course start date';
-$string['enrolmentenddate'] = 'Enrolment end date';
-$string['enrolmentstartdate'] = 'Enrolment start date';
-$string['expirydateone'] = 'Expiry date (1 year)';
-$string['expirydatetwo'] = 'Expiry date (2 year)';
-$string['expirydatethree'] = 'Expiry date (3 year)';
-$string['expirydatefour'] = 'Expiry date (4 year)';
-$string['expirydatefive'] = 'Expiry date (5 year)';
 $string['currentdate'] = 'Current date';
 $string['dateformat'] = 'Date format';
 $string['dateformat_help'] = 'This is the format of the date that will be displayed';
 $string['dateitem'] = 'Date item';
 $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['pluginname'] = 'Date';
-$string['privacy:metadata'] = 'The Date plugin does not store any personal data.';
 $string['numbersuffix_nd_as_in_second'] = 'nd';
 $string['numbersuffix_rd_as_in_third'] = 'rd';
 $string['numbersuffix_st_as_in_first'] = 'st';
+$string['pluginname'] = 'Date';
+$string['privacy:metadata'] = 'The Date plugin does not store any personal data.';
 $string['userdateformat'] = 'User date format';

element/daterange/tests/element_test.php

@@ -41,7 +41,7 @@
  * @copyright  2018 Dmitrii Metelkin <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class element_test extends advanced_testcase {
+final class element_test extends advanced_testcase {
 
     /**
      * Helper function to build element data.
@@ -128,7 +128,7 @@ public static function get_test_get_daterange_string_for_recurring_ranges_data_p
      * @param string $date Date to test.
      * @param string $expected Expected result.
      */
-    public function test_get_daterange_string_for_recurring_ranges($date, $expected) {
+    public function test_get_daterange_string_for_recurring_ranges($date, $expected): void {
         $dateranges = [
             (object)[
                 'startdate' => strtotime('01.04.2017'),
@@ -154,7 +154,7 @@ public function test_get_daterange_string_for_recurring_ranges($date, $expected)
      *
      * @covers \element::get_daterange_string
      */
-    public function test_that_first_matched_range_applied_first() {
+    public function test_that_first_matched_range_applied_first(): void {
         $dateranges = [
             (object)[
                 'startdate' => strtotime('01.04.2017'),
@@ -180,7 +180,7 @@ public function test_that_first_matched_range_applied_first() {
      *
      * @covers \element::get_daterange_string
      */
-    public function test_placeholders_and_fall_back_string() {
+    public function test_placeholders_and_fall_back_string(): void {
         $dateranges = [
             (object)[
                 'startdate' => strtotime('01.04.2017'),
@@ -207,7 +207,7 @@ public function test_placeholders_and_fall_back_string() {
      *
      * @covers \element::get_daterange_string
      */
-    public function test_nothing_will_be_displayed_if_empty_fallback_string() {
+    public function test_nothing_will_be_displayed_if_empty_fallback_string(): void {
         $dateranges = [
             (object)[
                 'startdate' => strtotime('01.04.2017'),
@@ -229,7 +229,7 @@ public function test_nothing_will_be_displayed_if_empty_fallback_string() {
      *
      * @covers \element::get_daterange_string
      */
-    public function test_recurring_range_first_year_and_recurring_range_last_year_placeholders() {
+    public function test_recurring_range_first_year_and_recurring_range_last_year_placeholders(): void {
         $datestring = '{{range_first_year}}-{{range_last_year}}-{{recurring_range_first_year}}-{{recurring_range_last_year}}';
         $dateranges = [
             (object) [

element/digitalsignature/lang/en/customcertelement_digitalsignature.php

@@ -26,9 +26,9 @@
 $string['nosignature'] = 'No signature';
 $string['pluginname'] = 'Digital signature';
 $string['privacy:metadata'] = 'The Digital signature plugin does not store any personal data.';
+$string['signaturecontactinfo'] = 'Signature contact info';
+$string['signaturelocation'] = 'Signature location';
 $string['signaturename'] = 'Signature name';
 $string['signaturepassword'] = 'Signature password';
-$string['signaturelocation'] = 'Signature location';
 $string['signaturereason'] = 'Signature reason';
-$string['signaturecontactinfo'] = 'Signature contact info';
 $string['uploaddigitalsignature'] = 'Upload digital signature';

element/grade/lang/en/customcertelement_grade.php

@@ -23,14 +23,13 @@
  */
 
 $string['coursegrade'] = 'Course grade';
-$string['gradeitem'] = 'Grade item';
-$string['gradeitem_help'] = 'The grade item you wish to display the grade of.';
 $string['gradeformat'] = 'Grade format';
 $string['gradeformat_help'] = 'The format you wish to use when displaying the grade.';
 $string['gradeitem'] = 'Grade item';
+$string['gradeitem_help'] = 'The grade item you wish to display the grade of.';
+$string['gradeletter'] = 'Letter';
 $string['gradepercent'] = 'Percentage';
 $string['gradepoints'] = 'Points';
-$string['gradeletter'] = 'Letter';
 $string['pluginname'] = 'Grade';
 $string['previewgrade'] = 'Preview grade';
 $string['privacy:metadata'] = 'The Grade plugin does not store any personal data.';

lang/en/customcert.php

@@ -41,22 +41,20 @@
 $string['createtemplate'] = 'Create template';
 $string['customcert:addinstance'] = 'Add a new custom certificate instance';
 $string['customcert:manage'] = 'Manage a custom certificate';
+$string['customcert:manageemailothers'] = 'Manage email others setting';
 $string['customcert:manageemailstudents'] = 'Manage email students setting';
 $string['customcert:manageemailteachers'] = 'Manage email teachers setting';
-$string['customcert:manageemailothers'] = 'Manage email others setting';
-$string['customcert:manageverifyany'] = 'Manage verification setting';
-$string['customcert:managerequiredtime'] = 'Manage time required setting';
+$string['customcert:managelanguages'] = 'Manage language on edit form';
 $string['customcert:manageprotection'] = 'Manage protection setting';
+$string['customcert:managerequiredtime'] = 'Manage time required setting';
+$string['customcert:manageverifyany'] = 'Manage verification setting';
 $string['customcert:receiveissue'] = 'Receive a certificate';
-$string['customcert:view'] = 'View a custom certificate';
-$string['customcert:viewreport'] = 'View course report';
-$string['customcert:viewallcertificates'] = 'View all certificates';
 $string['customcert:verifyallcertificates'] = 'Verify all certificates on the site';
 $string['customcert:verifycertificate'] = 'Verify a certificate';
+$string['customcert:view'] = 'View a custom certificate';
+$string['customcert:viewallcertificates'] = 'View all certificates';
+$string['customcert:viewreport'] = 'View course report';
 $string['customcertsettings'] = 'Custom certificate settings';
-$string['downloadallissuedcertificates'] = 'Download all issued certificates';
-$string['downloadallsitecertificates'] = 'Download all site certificates';
-$string['downloadallsitecertificatesdesc'] = 'This will download all the certificates on the site in a zip file.';
 $string['deletecertpage'] = 'Delete page';
 $string['deleteconfirm'] = 'Delete confirmation';
 $string['deleteelement'] = 'Delete element';
@@ -69,6 +67,9 @@
 $string['deliveryoptioninline'] = 'Send the file inline to the browser';
 $string['deliveryoptions'] = 'Delivery options';
 $string['description'] = 'Description';
+$string['downloadallissuedcertificates'] = 'Download all issued certificates';
+$string['downloadallsitecertificates'] = 'Download all site certificates';
+$string['downloadallsitecertificatesdesc'] = 'This will download all the certificates on the site in a zip file.';
 $string['duplicate'] = 'Duplicate';
 $string['duplicateconfirm'] = 'Duplicate confirmation';
 $string['duplicatetemplateconfirm'] = 'Are you sure you want to duplicate this certificate template?';
@@ -91,17 +92,17 @@
 $string['emailnonstudentcertificatelinktext'] = 'View certificate report';
 $string['emailnonstudentgreeting'] = 'Hi';
 $string['emailnonstudentsubject'] = '{$a->coursefullname}: {$a->certificatename}';
+$string['emailothers'] = 'Email others';
+$string['emailothers_help'] = 'If set this will email the email addresses listed here (separated by a comma) with a copy of the certificate when it becomes available. <strong>Warning:</strong> Setting this field before you have finished creating the certificate will email the addresses an incomplete certificate.';
 $string['emailstudentbody'] = 'Attached is your certificate \'{$a->certificatename}\' for the course \'{$a->coursefullname}\'.';
 $string['emailstudentbodyplaintext'] = 'Attached is your certificate \'{$a->certificatename}\' for the course \'{$a->coursefullname}\'.';
 $string['emailstudentcertificatelinktext'] = 'View certificate';
 $string['emailstudentgreeting'] = 'Dear {$a}';
-$string['emailstudentsubject'] = '{$a->coursefullname}: {$a->certificatename}';
 $string['emailstudents'] = 'Email students';
 $string['emailstudents_help'] = 'If set this will email the students a copy of the certificate when it becomes available. <strong>Warning:</strong> Setting this to \'Yes\' before you have finished creating the certificate will email the student an incomplete certificate.';
+$string['emailstudentsubject'] = '{$a->coursefullname}: {$a->certificatename}';
 $string['emailteachers'] = 'Email teachers';
 $string['emailteachers_help'] = 'If set this will email the teachers a copy of the certificate when it becomes available. <strong>Warning:</strong> Setting this to \'Yes\' before you have finished creating the certificate will email the teacher an incomplete certificate.';
-$string['emailothers'] = 'Email others';
-$string['emailothers_help'] = 'If set this will email the email addresses listed here (separated by a comma) with a copy of the certificate when it becomes available. <strong>Warning:</strong> Setting this field before you have finished creating the certificate will email the addresses an incomplete certificate.';
 $string['eventelementcreated'] = 'Custom certificate element created';
 $string['eventelementdeleted'] = 'Custom certificate element deleted';
 $string['eventelementupdated'] = 'Custom certificate element updated';
@@ -127,11 +128,12 @@
 $string['invalidelementwidthorheightnotnumber'] = 'Please enter a valid number.';
 $string['invalidelementwidthorheightzeroallowed'] = 'Please enter a number greater than or equal to 0.';
 $string['invalidelementwidthorheightzeronotallowed'] = 'Please enter a number greater than 0.';
-$string['invalidposition'] = 'Please select a positive number for position {$a}.';
 $string['invalidheight'] = 'The height has to be a valid number greater than 0.';
 $string['invalidmargin'] = 'The margin has to be a valid number greater than 0.';
+$string['invalidposition'] = 'Please select a positive number for position {$a}.';
 $string['invalidwidth'] = 'The width has to be a valid number greater than 0.';
 $string['landscape'] = 'Landscape';
+$string['languageoptions'] = 'Force Certificate Language';
 $string['leftmargin'] = 'Left margin';
 $string['leftmargin_help'] = 'This is the left margin of the certificate PDF in mm.';
 $string['listofissues'] = 'Recipients: {$a}';
@@ -142,9 +144,9 @@
 $string['managetemplatesdesc'] = 'This link will take you to a new screen where you will be able to manage templates used by Custom certificate activities in courses.';
 $string['modify'] = 'Modify';
 $string['modulename'] = 'Custom certificate';
-$string['modulenameplural'] = 'Custom certificates';
 $string['modulename_help'] = 'This module allows for the dynamic generation of PDF certificates.';
 $string['modulename_link'] = 'Custom_certificate_module';
+$string['modulenameplural'] = 'Custom certificates';
 $string['mycertificates'] = 'My certificates';
 $string['mycertificatesdescription'] = 'These are the certificates you have been issued by either email or downloading manually.';
 $string['name'] = 'Name';
@@ -166,10 +168,10 @@
 $string['posy_help'] = 'This is the position in mm from the top left corner you wish the element\'s reference point to locate in the y direction.';
 $string['preventcopy'] = 'Prevent copy';
 $string['preventcopy_desc'] = 'Enable protection from copy action.';
-$string['preventprint'] = 'Prevent print';
-$string['preventprint_desc'] = 'Enable protection from print action.';
 $string['preventmodify'] = 'Prevent modify';
 $string['preventmodify_desc'] = 'Enable protection from modify action.';
+$string['preventprint'] = 'Prevent print';
+$string['preventprint_desc'] = 'Enable protection from print action.';
 $string['print'] = 'Print';
 $string['privacy:metadata:customcert_issues'] = 'The list of issued certificates';
 $string['privacy:metadata:customcert_issues:code'] = 'The code that belongs to the certificate';
@@ -187,9 +189,9 @@
 $string['rightmargin'] = 'Right margin';
 $string['rightmargin_help'] = 'This is the right margin of the certificate PDF in mm.';
 $string['save'] = 'Save';
-$string['savechanges'] = 'Save changes';
 $string['saveandclose'] = 'Save and close';
 $string['saveandcontinue'] = 'Save and continue';
+$string['savechanges'] = 'Save changes';
 $string['savechangespreview'] = 'Save changes and preview';
 $string['savetemplate'] = 'Save template';
 $string['search:activity'] = 'Custom certificate - activity information';
@@ -211,22 +213,17 @@
 $string['uploadimage'] = 'Upload image';
 $string['uploadimagedesc'] = 'This link will take you to a new screen where you will be able to upload images. Images uploaded using
 this method will be available throughout your site to all users who are able to create a certificate.';
+$string['userlanguage'] = 'Use user preferences';
+$string['userlanguage_help'] = 'You can force the language of the certificate to override the user\'s language preferences.';
 $string['verified'] = 'Verified';
 $string['verify'] = 'Verify';
 $string['verifyallcertificates'] = 'Allow verification of all certificates';
 $string['verifyallcertificates_desc'] = 'When this setting is enabled any person (including users not logged in) can visit the link \'{$a}\' in order to verify any certificate on the site, rather than having to go to the verification link for each certificate.
 
 Note - this only applies to certificates where \'Allow anyone to verify a certificate\' has been set to \'Yes\' in the certificate settings.';
 $string['verifycertificate'] = 'Verify certificate';
-$string['verifycertificatedesc'] = 'This link will take you to a new screen where you will be able to verify certificates on the site';
 $string['verifycertificateanyone'] = 'Allow anyone to verify a certificate';
 $string['verifycertificateanyone_help'] = 'This setting enables anyone with the certificate verification link (including users not logged in) to verify a certificate.';
+$string['verifycertificatedesc'] = 'This link will take you to a new screen where you will be able to verify certificates on the site';
 $string['width'] = 'Width';
 $string['width_help'] = 'This is the width of the certificate PDF in mm. For reference an A4 piece of paper is 210mm wide and a letter is 216mm wide.';
-
-$string['userlanguage'] = 'Use user preferences';
-$string['languageoptions'] = 'Force Certificate Language';
-$string['userlanguage_help'] = 'You can force the language of the certificate to override the user\'s language preferences.';
-
-// Acess API.
-$string['customcert:managelanguages'] = 'Manage language on edit form';

tests/element_helper_test.php

@@ -39,7 +39,7 @@
  * @copyright  2017 Mark Nelson <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class element_helper_test extends advanced_testcase {
+final class element_helper_test extends advanced_testcase {
 
     /**
      * Test set up.
@@ -53,7 +53,7 @@ public function setUp(): void {
      *
      * @covers \element_helper::get_courseid
      */
-    public function test_get_courseid_element_in_course_certificate() {
+    public function test_get_courseid_element_in_course_certificate(): void {
         global $DB;
 
         // Create a course.
@@ -87,7 +87,7 @@ public function test_get_courseid_element_in_course_certificate() {
      *
      * @covers \element_helper::get_courseid
      */
-    public function test_get_courseid_element_in_site_template() {
+    public function test_get_courseid_element_in_site_template(): void {
         global $DB, $SITE;
 
         // Add a template to the site.
@@ -114,7 +114,7 @@ public function test_get_courseid_element_in_site_template() {
      *
      * @covers \element_helper::get_context
      */
-    public function test_get_context_element_in_course_certificate() {
+    public function test_get_context_element_in_course_certificate(): void {
         global $DB;
 
         // Create a course.
@@ -149,7 +149,7 @@ public function test_get_context_element_in_course_certificate() {
      *
      * @covers \element_helper::get_context
      */
-    public function test_get_context_element_in_site_template() {
+    public function test_get_context_element_in_site_template(): void {
         global $DB;
 
         // Add a template to the site.
@@ -176,7 +176,7 @@ public function test_get_context_element_in_site_template() {
      *
      * @covers \element_helper::get_grade_items
      */
-    public function test_get_grade_items() {
+    public function test_get_grade_items(): void {
         global $DB;
 
         // Create a course.
@@ -219,7 +219,7 @@ public function test_get_grade_items() {
      *
      * @covers \element_helper::get_mod_grade_info
      */
-    public function test_get_mod_grade_info() {
+    public function test_get_mod_grade_info(): void {
         // Create a course.
         $course = $this->getDataGenerator()->create_course();
 
@@ -290,7 +290,7 @@ public function test_get_mod_grade_info() {
      *
      * @covers \element_helper::get_course_grade_info
      */
-    public function test_get_course_grade_info() {
+    public function test_get_course_grade_info(): void {
         // Create a course.
         $course = $this->getDataGenerator()->create_course();
 
@@ -352,7 +352,7 @@ public function test_get_course_grade_info() {
      *
      * @covers \element_helper::get_grade_item_info
      */
-    public function test_get_grade_item_info() {
+    public function test_get_grade_item_info(): void {
         // Create a course.
         $course = $this->getDataGenerator()->create_course();