mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-21 00:12:56 +02:00
Code Issues Projects Releases Wiki Activity

MDL-72035 csvlib: Write BOM for Excel

Browse Source 
Add option to class csv_export_writer to prefix CSV file with UTF-8 byte
order mark (BOM).  This helps Microsoft Excel detect the file's character
encoding.
This commit is contained in:
Leon Stringer 2021-06-30 15:04:16 +01:00
parent a747fd3055
commit 22825647d4
3 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/classes/text.php
View File

@ -41,6 +41,8 @@ defined('MOODLE_INTERNAL') || die();
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_text {
/** @var string Byte order mark for UTF-8 */
const UTF8_BOM = "\xef\xbb\xbf";
/**
* @var string[] Array of strings representing Unicode non-characters
@ -538,7 +540,7 @@ class core_text {
* @return string
*/
public static function trim_utf8_bom($str) {
$bom = "\xef\xbb\xbf";
$bom = self::UTF8_BOM;
if (strpos($str, $bom) === 0) {
return substr($str, strlen($bom));
}

12
lib/csvlib.class.php
View File

@ -390,6 +390,10 @@ class csv_export_writer {
* @var string $path The directory path for storing the temporary csv file.
*/
var $path;
/**
* @var boolean $bom If true prefix file with byte order mark (BOM).
*/
private $bom = false;
/**
* @var resource $fp File pointer for the csv file.
*/
@ -401,8 +405,9 @@ class csv_export_writer {
* @param string $delimiter The name of the character used to seperate fields. Supported types(comma, tab, semicolon, colon, cfg)
* @param string $enclosure The character used for determining the enclosures.
* @param string $mimetype Mime type of the file that we are exporting.
* @param boolean $bom If true, prefix file with byte order mark.
*/
public function __construct($delimiter = 'comma', $enclosure = '"', $mimetype = 'application/download') {
public function __construct($delimiter = 'comma', $enclosure = '"', $mimetype = 'application/download', $bom = false) {
$this->delimiter = $delimiter;
// Check that the enclosure is a single character.
if (strlen($enclosure) == 1) {
@ -412,6 +417,7 @@ class csv_export_writer {
}
$this->filename = "Moodle-data-export.csv";
$this->mimetype = $mimetype;
$this->bom = $bom;
}
/**
@ -437,6 +443,10 @@ class csv_export_writer {
if(!isset($this->path)) {
$this->set_temp_file_path();
$this->fp = fopen($this->path, 'w+');
if ($this->bom) {
fputs($this->fp, core_text::UTF8_BOM);
}
}
$delimiter = csv_import_reader::get_delimiter($this->delimiter);
fputcsv($this->fp, $row, $delimiter, $this->csvenclosure);

2
report/completion/index.php
View File

@ -149,7 +149,7 @@ if ($csv) {
$shortname = format_string($course->shortname, true, array('context' => $context));
$shortname = preg_replace('/[^a-z0-9-]/', '_',core_text::strtolower(strip_tags($shortname)));
$export = new csv_export_writer();
$export = new csv_export_writer('comma', '"', 'application/download', $excel);
$export->set_filename('completion-'.$shortname);
} else {