Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/spout/src/Spout/Common/Helper/Escaper/ -> XLSX.php (source)

[Source view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401]

(no description)

File Size: 190 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

XLSX:: (9 methods):
  initIfNeeded()
  escape()
  unescape()
  getEscapableControlCharactersPattern()
  getControlCharactersEscapingMap()
  escapeControlCharacters()
  escapeEscapeCharacter()
  unescapeControlCharacters()
  unescapeEscapeCharacter()


Class: XLSX  - X-Ref

Class XLSX
Provides functions to escape and unescape data for XLSX files

initIfNeeded()   X-Ref
Initializes the control characters if not already done


escape($string)   X-Ref
Escapes the given string to make it compatible with XLSX

param: string $string The string to escape
return: string The escaped string

unescape($string)   X-Ref
Unescapes the given string to make it compatible with XLSX

param: string $string The string to unescape
return: string The unescaped string

getEscapableControlCharactersPattern()   X-Ref

return: string Regex pattern containing all escapable control characters

getControlCharactersEscapingMap()   X-Ref
Builds the map containing control characters to be escaped
mapped to their escaped values.
"\t", "\r" and "\n" don't need to be escaped.

NOTE: the logic has been adapted from the XlsxWriter library (BSD License)
return: string[]

escapeControlCharacters($string)   X-Ref
Converts PHP control characters from the given string to OpenXML escaped control characters

Excel escapes control characters with _xHHHH_ and also escapes any
literal strings of that type by encoding the leading underscore.
So "\0" -> _x0000_ and "_x0000_" -> _x005F_x0000_.

NOTE: the logic has been adapted from the XlsxWriter library (BSD License)
param: string $string String to escape
return: string

escapeEscapeCharacter($string)   X-Ref
Escapes the escape character: "_x0000_" -> "_x005F_x0000_"

param: string $string String to escape
return: string The escaped string

unescapeControlCharacters($string)   X-Ref
Converts OpenXML escaped control characters from the given string to PHP control characters

Excel escapes control characters with _xHHHH_ and also escapes any
literal strings of that type by encoding the leading underscore.
So "_x0000_" -> "\0" and "_x005F_x0000_" -> "_x0000_"

NOTE: the logic has been adapted from the XlsxWriter library (BSD License)
param: string $string String to unescape
return: string

unescapeEscapeCharacter($string)   X-Ref
Unecapes the escape character: "_x005F_x0000_" => "_x0000_"

param: string $string String to unescape
return: string The unescaped string