MDL-65547 qr: Wrapper for core_qrcode

2020-05-08 10:26:45 +02:00
parent 812aaf73d7
commit f24b0795ef
2 changed files with 100 additions and 0 deletions
@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Class for generating QR codes. Wrapper class that extends TCPDF.
+ *
+ * @package    core
+ * @copyright  2020 Moodle Pty Ltd.
+ * @author     Juan Leyva <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/tcpdf/tcpdf_barcodes_2d.php');
+
+/**
+ * Class for generating QR codes. Wrapper class that extends TCPDF.
+ *
+ * @copyright  2020 Moodle Pty Ltd.
+ */
+class core_qrcode extends TCPDF2DBarcode {
+
+    /**
+     * Overrided constructor to force QR codes.
+     *
+     * @param string $data the data to generate the code
+     */
+    public function __construct($data) {
+
+        parent::__construct($data, 'QRCODE');
+    }
+}
@@ -0,0 +1,54 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Test QR code functionality.
+ *
+ * @package    core
+ * @copyright  Moodle Pty Ltd
+ * @author     <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * A set of tests for some of the QR code functionality within Moodle.
+ *
+ * @package    core
+ * @copyright  Moodle Pty Ltd
+ * @author     <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_qrcode_testcase extends basic_testcase {
+
+    /**
+     * Basic test to generate a QR code and check that the library is not broken.
+     */
+    public function test_generate_basic_qr() {
+        // The QR code generator library apply masks by random order, this is why everytime a QR code is generated the resultant
+        // binary file can be different. This is why tests are limited.
+
+        $text = 'abc';
+        $color = 'black';
+        $qrcode = new core_qrcode($text, $color);
+        $svgdata = $qrcode->getBarcodeSVGcode(1, 1);
+
+        // Just check the SVG was generated.
+        $this->assertContains('<desc>' . $text . '</desc>', $svgdata);
+        $this->assertContains('fill="' . $color . '"', $svgdata);
+    }
+}