first commit

dataformat/excel/classes/privacy/provider.php

@@ -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/>.
+
+/**
+ * Privacy provider implementation for dataformat_excel.
+ *
+ * @package    dataformat_excel
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace dataformat_excel\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy provider implementation for dataformat_excel.
+ *
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

dataformat/excel/classes/writer.php

@@ -0,0 +1,67 @@
+<?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/>.
+
+/**
+ * Excel data format writer
+ *
+ * @package    dataformat_excel
+ * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace dataformat_excel;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Excel data format writer
+ *
+ * @package    dataformat_excel
+ * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class writer extends \core\dataformat\spout_base {
+
+    /** @var $mimetype */
+    protected $mimetype = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+
+    /** @var $extension */
+    protected $extension = ".xlsx";
+
+
+    /**
+     * Set the title of the worksheet inside a spreadsheet
+     *
+     * For some formats this will be ignored.
+     *
+     * @param string $title
+     */
+    public function set_sheettitle($title) {
+        if (!$title) {
+            return;
+        }
+
+        // Replace any characters in the name that Excel cannot cope with.
+        $title = strtr(trim($title, "'"), '[]*/\?:', '       ');
+        // Shorten the title if necessary.
+        $title = \core_text::substr($title, 0, 31);
+        // After the substr, we might now have a single quote on the end.
+        $title = trim($title, "'");
+
+        $this->sheettitle = $title;
+    }
+}
+

dataformat/excel/lang/en/dataformat_excel.php

@@ -0,0 +1,28 @@
+<?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/>.
+
+/**
+ * Excel dataformat lang strings.
+ *
+ * @package    dataformat_excel
+ * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['dataformat'] = 'Microsoft Excel (.xlsx)';
+$string['privacy:metadata'] = 'The Excel data format plugin does not store any personal data.';
+$string['shortname'] = 'Excel';
+

dataformat/excel/tests/writer_test.php

@@ -0,0 +1,81 @@
+<?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/>.
+
+namespace dataformat_excel;
+
+use core\dataformat;
+
+/**
+ * Tests for the dataformat_excel writer
+ *
+ * @package    dataformat_excel
+ * @copyright  2022 Marina Glancy
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class writer_test extends \advanced_testcase {
+
+    /**
+     * Test writing data whose content contains an image with pluginfile.php source
+     */
+    public function test_write_data(): void {
+        $columns = ['fruit', 'colour', 'animal'];
+        $rows = [
+            ['banana', 'yellow', 'monkey'],
+            ['apple', 'red', 'wolf'],
+            ['melon', 'green', 'aardvark'],
+        ];
+
+        // Export to file.
+        $exportfile = dataformat::write_data('My export', 'excel', $columns, $rows);
+
+        // Read the file.
+        $excelcells = $this->get_excel(file_get_contents($exportfile));
+
+        $this->assertEquals(array_merge([$columns], $rows), $excelcells);
+    }
+
+    /**
+     * Get an Excel object to check the content
+     *
+     * @param string $content
+     * @return array two-dimensional array with cell values
+     */
+    private function get_excel(string $content) {
+        $file = tempnam(sys_get_temp_dir(), 'excel_');
+        $handle = fopen($file, "w");
+        fwrite($handle, $content);
+        /** @var \OpenSpout\Reader\XLSX\Reader $reader */
+        $reader = \OpenSpout\Reader\Common\Creator\ReaderFactory::createFromFileByMimeType($file);
+        $reader->open($file);
+
+        /** @var \OpenSpout\Reader\XLSX\Sheet[] $sheets */
+        $sheets = $reader->getSheetIterator();
+        $rowscellsvalues = [];
+        foreach ($sheets as $sheet) {
+            /** @var \OpenSpout\Common\Entity\Row[] $rows */
+            $rows = $sheet->getRowIterator();
+            foreach ($rows as $row) {
+                $thisvalues = [];
+                foreach ($row->getCells() as $cell) {
+                    $thisvalues[] = $cell->getValue();
+                }
+                $rowscellsvalues[] = $thisvalues;
+            }
+        }
+
+        return $rowscellsvalues;
+    }
+}

dataformat/excel/version.php

@@ -0,0 +1,30 @@
+<?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/>.
+
+/**
+ * Data activity filter version information
+ *
+ * @package    dataformat_excel
+ * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;
+$plugin->requires  = 2024041600;  // Requires this Moodle version.
+$plugin->component = 'dataformat_excel';
+