64 lines
2.3 KiB
PHP
64 lines
2.3 KiB
PHP
<?php
|
||
|
||
namespace OpenSpout\Common\Helper\Escaper;
|
||
|
||
/**
|
||
* Provides functions to escape and unescape data for ODS files.
|
||
*/
|
||
class ODS implements EscaperInterface
|
||
{
|
||
/**
|
||
* Escapes the given string to make it compatible with XLSX.
|
||
*
|
||
* @param string $string The string to escape
|
||
*
|
||
* @return string The escaped string
|
||
*/
|
||
public function escape($string)
|
||
{
|
||
// @NOTE: Using ENT_QUOTES as XML entities ('<', '>', '&') as well as
|
||
// single/double quotes (for XML attributes) need to be encoded.
|
||
if (\defined('ENT_DISALLOWED')) {
|
||
/**
|
||
* 'ENT_DISALLOWED' ensures that invalid characters in the given document type are replaced.
|
||
* Otherwise control characters like a vertical tab "\v" will make the XML document unreadable by the XML processor.
|
||
*
|
||
* @see https://github.com/box/spout/issues/329
|
||
*/
|
||
$replacedString = htmlspecialchars($string, ENT_QUOTES | ENT_DISALLOWED, 'UTF-8');
|
||
} else {
|
||
// We are on hhvm or any other engine that does not support ENT_DISALLOWED.
|
||
$escapedString = htmlspecialchars($string, ENT_QUOTES, 'UTF-8');
|
||
|
||
// control characters values are from 0 to 1F (hex values) in the ASCII table
|
||
// some characters should not be escaped though: "\t", "\r" and "\n".
|
||
$regexPattern = '[\x00-\x08'.
|
||
// skipping "\t" (0x9) and "\n" (0xA)
|
||
'\x0B-\x0C'.
|
||
// skipping "\r" (0xD)
|
||
'\x0E-\x1F]';
|
||
$replacedString = preg_replace("/{$regexPattern}/", '<27>', $escapedString);
|
||
}
|
||
|
||
return $replacedString;
|
||
}
|
||
|
||
/**
|
||
* Unescapes the given string to make it compatible with XLSX.
|
||
*
|
||
* @param string $string The string to unescape
|
||
*
|
||
* @return string The unescaped string
|
||
*/
|
||
public function unescape($string)
|
||
{
|
||
// ==============
|
||
// = WARNING =
|
||
// ==============
|
||
// It is assumed that the given string has already had its XML entities decoded.
|
||
// This is true if the string is coming from a DOMNode (as DOMNode already decode XML entities on creation).
|
||
// Therefore there is no need to call "htmlspecialchars_decode()".
|
||
return $string;
|
||
}
|
||
}
|