MDL-51603 dataformat: Fixed worksheet title bug

dataformat/excel/classes/writer.php

@@ -46,5 +46,26 @@ class writer extends \core\dataformat\spout_base {
     /** @var $spouttype */
     protected $spouttype = \Box\Spout\Common\Type::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;
+    }
 }
 

lib/classes/dataformat/spout_base.php

@@ -51,6 +51,10 @@ public function send_http_headers() {
         $this->writer = \Box\Spout\Writer\WriterFactory::create($this->spouttype);
         $filename = $this->filename . $this->get_extension();
         $this->writer->openToBrowser($filename);
+        if ($this->sheettitle) {
+            $sheet = $this->writer->getCurrentSheet();
+            $sheet->setName($this->sheettitle);
+        }
     }
 
     /**
@@ -64,11 +68,7 @@ public function set_sheettitle($title) {
         if (!$title) {
             return;
         }
-        $title = preg_replace('/[\\\\\/\\?\\*\\[\\]]/', '', $title);
-        $title = substr($title, 0, 31);
         $this->sheettitle = $title;
-        $sheet = $this->writer->getCurrentSheet();
-        $sheet->setName($title);
     }
 
     /**