Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\StringHelper:

Static Public Member Functions
static	getIsIconvEnabled ()
	Get whether iconv extension is available. More...

static	controlCharacterOOXML2PHP ($value)
	Convert from OpenXML escaped control character to PHP control character. More...

static	controlCharacterPHP2OOXML ($value)
	Convert from PHP control character to OpenXML escaped control character. More...

static	sanitizeUTF8 ($value)
	Try to sanitize UTF8, stripping invalid byte sequences. More...

static	isUTF8 ($value)
	Check if a string contains UTF8 data. More...

static	formatNumber ($value)
	Formats a numeric value as a string for output in various output writers forcing point as decimal separator in case locale is other than English. More...

static	UTF8toBIFF8UnicodeShort ($value, $arrcRuns=[])
	Converts a UTF-8 string into BIFF8 Unicode string data (8-bit string length) Writes the string using uncompressed notation, no rich text, no Asian phonetics If mbstring extension is not available, ASCII is assumed, and compressed notation is used although this will give wrong results for non-ASCII strings see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect. More...

static	UTF8toBIFF8UnicodeLong ($value)
	Converts a UTF-8 string into BIFF8 Unicode string data (16-bit string length) Writes the string using uncompressed notation, no rich text, no Asian phonetics If mbstring extension is not available, ASCII is assumed, and compressed notation is used although this will give wrong results for non-ASCII strings see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect. More...

static	convertEncoding ($value, $to, $from)
	Convert string from one encoding to another. More...

static	countCharacters ($value, $enc='UTF-8')
	Get character count. More...

static	substring ($pValue, $pStart, $pLength=0)
	Get a substring of a UTF-8 encoded string. More...

static	strToUpper ($pValue)
	Convert a UTF-8 encoded string to upper case. More...

static	strToLower ($pValue)
	Convert a UTF-8 encoded string to lower case. More...

static	strToTitle ($pValue)
	Convert a UTF-8 encoded string to title/proper case (uppercase every first character in each word, lower case all other characters). More...

static	mbIsUpper ($char)

static	mbStrSplit ($string)

static	strCaseReverse ($pValue)
	Reverse the case of a string, so that all uppercase characters become lowercase and all lowercase characters become uppercase. More...

static	convertToNumberIfFraction (&$operand)
	Identify whether a string contains a fractional numeric value, and convert it to a numeric if it is. More...

static	getDecimalSeparator ()
	Get the decimal separator. More...

static	setDecimalSeparator ($pValue)
	Set the decimal separator. More...

static	getThousandsSeparator ()
	Get the thousands separator. More...

static	setThousandsSeparator ($pValue)
	Set the thousands separator. More...

static	getCurrencyCode ()
	Get the currency code. More...

static	setCurrencyCode ($pValue)
	Set the currency code. More...

static	SYLKtoUTF8 ($pValue)
	Convert SYLK encoded string to UTF-8. More...

static	testStringAsNumeric ($value)
	Retrieve any leading numeric part of a string, or return the full string if no leading numeric (handles basic integer or float, but not exponent or non decimal). More...

Data Fields
const	STRING_REGEXP_FRACTION = '(-?)(\d+)\s+(\d+\/\d+)'
	Constants. More...

Static Private Member Functions
static	buildControlCharacters ()
	Build control characters array. More...

static	buildSYLKCharacters ()
	Build SYLK characters array. More...

static	buildCharacterSets ()

Static Private Attributes
static	$controlCharacters = []

static	$SYLKCharacters = []

static	$decimalSeparator

static	$thousandsSeparator

static	$currencyCode

static	$isIconvEnabled

static	$iconvOptions = '//IGNORE//TRANSLIT'

Detailed Description

Definition at line 7 of file StringHelper.php.

Member Function Documentation

◆ buildCharacterSets()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::buildCharacterSets ( )

staticprivate

Definition at line 275 of file StringHelper.php.

                                                 : void
     {
         if (empty(self::$controlCharacters)) {
             self::buildControlCharacters();
         }
 
         if (empty(self::$SYLKCharacters)) {
             self::buildSYLKCharacters();
         }
     }

◆ buildControlCharacters()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::buildControlCharacters ( )

staticprivate

Build control characters array.

Definition at line 66 of file StringHelper.php.

References $i.

                                                     : void
     {
         for ($i = 0; $i <= 31; ++$i) {
             if ($i != 9 && $i != 10 && $i != 13) {
                 $find = '_x' . sprintf('%04s', strtoupper(dechex($i))) . '_';
                 $replace = chr($i);
                 self::$controlCharacters[$find] = $replace;
             }
         }
     }

◆ buildSYLKCharacters()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::buildSYLKCharacters ( )

staticprivate

Build SYLK characters array.

Definition at line 80 of file StringHelper.php.

                                                  : void
     {
         self::$SYLKCharacters = [
             "\x1B 0" => chr(0),
             "\x1B 1" => chr(1),
             "\x1B 2" => chr(2),
             "\x1B 3" => chr(3),
             "\x1B 4" => chr(4),
             "\x1B 5" => chr(5),
             "\x1B 6" => chr(6),
             "\x1B 7" => chr(7),
             "\x1B 8" => chr(8),
             "\x1B 9" => chr(9),
             "\x1B :" => chr(10),
             "\x1B ;" => chr(11),
             "\x1B <" => chr(12),
             "\x1B =" => chr(13),
             "\x1B >" => chr(14),
             "\x1B ?" => chr(15),
             "\x1B!0" => chr(16),
             "\x1B!1" => chr(17),
             "\x1B!2" => chr(18),
             "\x1B!3" => chr(19),
             "\x1B!4" => chr(20),
             "\x1B!5" => chr(21),
             "\x1B!6" => chr(22),
             "\x1B!7" => chr(23),
             "\x1B!8" => chr(24),
             "\x1B!9" => chr(25),
             "\x1B!:" => chr(26),
             "\x1B!;" => chr(27),
             "\x1B!<" => chr(28),
             "\x1B!=" => chr(29),
             "\x1B!>" => chr(30),
             "\x1B!?" => chr(31),
             "\x1B'?" => chr(127),
             "\x1B(0" => '€', // 128 in CP1252
             "\x1B(2" => '‚', // 130 in CP1252
             "\x1B(3" => 'ƒ', // 131 in CP1252
             "\x1B(4" => '„', // 132 in CP1252
             "\x1B(5" => '…', // 133 in CP1252
             "\x1B(6" => '†', // 134 in CP1252
             "\x1B(7" => '‡', // 135 in CP1252
             "\x1B(8" => 'ˆ', // 136 in CP1252
             "\x1B(9" => '‰', // 137 in CP1252
             "\x1B(:" => 'Š', // 138 in CP1252
             "\x1B(;" => '‹', // 139 in CP1252
             "\x1BNj" => 'Œ', // 140 in CP1252
             "\x1B(>" => 'Ž', // 142 in CP1252
             "\x1B)1" => '‘', // 145 in CP1252
             "\x1B)2" => '’', // 146 in CP1252
             "\x1B)3" => '“', // 147 in CP1252
             "\x1B)4" => '”', // 148 in CP1252
             "\x1B)5" => '•', // 149 in CP1252
             "\x1B)6" => '–', // 150 in CP1252
             "\x1B)7" => '—', // 151 in CP1252
             "\x1B)8" => '˜', // 152 in CP1252
             "\x1B)9" => '™', // 153 in CP1252
             "\x1B):" => 'š', // 154 in CP1252
             "\x1B);" => '›', // 155 in CP1252
             "\x1BNz" => 'œ', // 156 in CP1252
             "\x1B)>" => 'ž', // 158 in CP1252
             "\x1B)?" => 'Ÿ', // 159 in CP1252
             "\x1B*0" => ' ', // 160 in CP1252
             "\x1BN!" => '¡', // 161 in CP1252
             "\x1BN\"" => '¢', // 162 in CP1252
             "\x1BN#" => '£', // 163 in CP1252
             "\x1BN(" => '¤', // 164 in CP1252
             "\x1BN%" => '¥', // 165 in CP1252
             "\x1B*6" => '¦', // 166 in CP1252
             "\x1BN'" => '§', // 167 in CP1252
             "\x1BNH " => '¨', // 168 in CP1252
             "\x1BNS" => '©', // 169 in CP1252
             "\x1BNc" => 'ª', // 170 in CP1252
             "\x1BN+" => '«', // 171 in CP1252
             "\x1B*<" => '¬', // 172 in CP1252
             "\x1B*=" => '­', // 173 in CP1252
             "\x1BNR" => '®', // 174 in CP1252
             "\x1B*?" => '¯', // 175 in CP1252
             "\x1BN0" => '°', // 176 in CP1252
             "\x1BN1" => '±', // 177 in CP1252
             "\x1BN2" => '²', // 178 in CP1252
             "\x1BN3" => '³', // 179 in CP1252
             "\x1BNB " => '´', // 180 in CP1252
             "\x1BN5" => 'µ', // 181 in CP1252
             "\x1BN6" => '¶', // 182 in CP1252
             "\x1BN7" => '·', // 183 in CP1252
             "\x1B+8" => '¸', // 184 in CP1252
             "\x1BNQ" => '¹', // 185 in CP1252
             "\x1BNk" => 'º', // 186 in CP1252
             "\x1BN;" => '»', // 187 in CP1252
             "\x1BN<" => '¼', // 188 in CP1252
             "\x1BN=" => '½', // 189 in CP1252
             "\x1BN>" => '¾', // 190 in CP1252
             "\x1BN?" => '¿', // 191 in CP1252
             "\x1BNAA" => 'À', // 192 in CP1252
             "\x1BNBA" => 'Á', // 193 in CP1252
             "\x1BNCA" => 'Â', // 194 in CP1252
             "\x1BNDA" => 'Ã', // 195 in CP1252
             "\x1BNHA" => 'Ä', // 196 in CP1252
             "\x1BNJA" => 'Å', // 197 in CP1252
             "\x1BNa" => 'Æ', // 198 in CP1252
             "\x1BNKC" => 'Ç', // 199 in CP1252
             "\x1BNAE" => 'È', // 200 in CP1252
             "\x1BNBE" => 'É', // 201 in CP1252
             "\x1BNCE" => 'Ê', // 202 in CP1252
             "\x1BNHE" => 'Ë', // 203 in CP1252
             "\x1BNAI" => 'Ì', // 204 in CP1252
             "\x1BNBI" => 'Í', // 205 in CP1252
             "\x1BNCI" => 'Î', // 206 in CP1252
             "\x1BNHI" => 'Ï', // 207 in CP1252
             "\x1BNb" => 'Ð', // 208 in CP1252
             "\x1BNDN" => 'Ñ', // 209 in CP1252
             "\x1BNAO" => 'Ò', // 210 in CP1252
             "\x1BNBO" => 'Ó', // 211 in CP1252
             "\x1BNCO" => 'Ô', // 212 in CP1252
             "\x1BNDO" => 'Õ', // 213 in CP1252
             "\x1BNHO" => 'Ö', // 214 in CP1252
             "\x1B-7" => '×', // 215 in CP1252
             "\x1BNi" => 'Ø', // 216 in CP1252
             "\x1BNAU" => 'Ù', // 217 in CP1252
             "\x1BNBU" => 'Ú', // 218 in CP1252
             "\x1BNCU" => 'Û', // 219 in CP1252
             "\x1BNHU" => 'Ü', // 220 in CP1252
             "\x1B-=" => 'Ý', // 221 in CP1252
             "\x1BNl" => 'Þ', // 222 in CP1252
             "\x1BN{" => 'ß', // 223 in CP1252
             "\x1BNAa" => 'à', // 224 in CP1252
             "\x1BNBa" => 'á', // 225 in CP1252
             "\x1BNCa" => 'â', // 226 in CP1252
             "\x1BNDa" => 'ã', // 227 in CP1252
             "\x1BNHa" => 'ä', // 228 in CP1252
             "\x1BNJa" => 'å', // 229 in CP1252
             "\x1BNq" => 'æ', // 230 in CP1252
             "\x1BNKc" => 'ç', // 231 in CP1252
             "\x1BNAe" => 'è', // 232 in CP1252
             "\x1BNBe" => 'é', // 233 in CP1252
             "\x1BNCe" => 'ê', // 234 in CP1252
             "\x1BNHe" => 'ë', // 235 in CP1252
             "\x1BNAi" => 'ì', // 236 in CP1252
             "\x1BNBi" => 'í', // 237 in CP1252
             "\x1BNCi" => 'î', // 238 in CP1252
             "\x1BNHi" => 'ï', // 239 in CP1252
             "\x1BNs" => 'ð', // 240 in CP1252
             "\x1BNDn" => 'ñ', // 241 in CP1252
             "\x1BNAo" => 'ò', // 242 in CP1252
             "\x1BNBo" => 'ó', // 243 in CP1252
             "\x1BNCo" => 'ô', // 244 in CP1252
             "\x1BNDo" => 'õ', // 245 in CP1252
             "\x1BNHo" => 'ö', // 246 in CP1252
             "\x1B/7" => '÷', // 247 in CP1252
             "\x1BNy" => 'ø', // 248 in CP1252
             "\x1BNAu" => 'ù', // 249 in CP1252
             "\x1BNBu" => 'ú', // 250 in CP1252
             "\x1BNCu" => 'û', // 251 in CP1252
             "\x1BNHu" => 'ü', // 252 in CP1252
             "\x1B/=" => 'ý', // 253 in CP1252
             "\x1BN|" => 'þ', // 254 in CP1252
             "\x1BNHy" => 'ÿ', // 255 in CP1252
         ];
     }

◆ controlCharacterOOXML2PHP()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::controlCharacterOOXML2PHP ( $value )

static

Convert from OpenXML escaped control character to PHP control character.

Excel 2007 team:

That's correct, control characters are stored directly in the shared-strings table. We do encode characters that cannot be represented in XML using the following escape sequence: xHHHH where H represents a hexadecimal character in the character's value... So you could end up with something like x0008 in a string (either in a cell value (<v>) element or in the shared string <t> element.

Parameters

string $value Value to unescape

Returns: string

Definition at line 301 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\readStyle().

     {
         self::buildCharacterSets();
 
         return str_replace(array_keys(self::$controlCharacters), array_values(self::$controlCharacters), $value);
     }

Here is the caller graph for this function:

◆ controlCharacterPHP2OOXML()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::controlCharacterPHP2OOXML ( $value )

static

Convert from PHP control character to OpenXML escaped control character.

Excel 2007 team:

That's correct, control characters are stored directly in the shared-strings table. We do encode characters that cannot be represented in XML using the following escape sequence: xHHHH where H represents a hexadecimal character in the character's value... So you could end up with something like x0008 in a string (either in a cell value (<v>) element or in the shared string <t> element.

Parameters

string $value Value to escape

Returns: string

Definition at line 323 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeCategoryAxis(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCellInlineStr(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable\writeRichText(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable\writeRichTextForCharts(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable\writeStringTable(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

     {
         self::buildCharacterSets();
 
         return str_replace(array_values(self::$controlCharacters), array_keys(self::$controlCharacters), $value);
     }

Here is the caller graph for this function:

◆ convertEncoding()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::convertEncoding	(	$value,
		$to,
		$from
	)

static

Convert string from one encoding to another.

Parameters

string	$value
string	$to	Encoding to convert to, e.g. 'UTF-8'
string	$from	Encoding to convert from, e.g. 'UTF-16LE'

Returns: string

Definition at line 445 of file StringHelper.php.

References $from, and $result.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\canRead(), PhpOffice\PhpSpreadsheet\Reader\Xls\decodeCodepage(), PhpOffice\PhpSpreadsheet\Reader\Xls\encodeUTF16(), PhpOffice\PhpSpreadsheet\Reader\Csv\openFileOrMemory(), PhpOffice\PhpSpreadsheet\Reader\Xls\readDocumentSummaryInformation(), PhpOffice\PhpSpreadsheet\Reader\Xls\readSummaryInformation(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeUrlInternal().

     {
         if (self::getIsIconvEnabled()) {
             $result = iconv($from, $to . self::$iconvOptions, $value);
             if (false !== $result) {
                 return $result;
             }
         }
 
         return mb_convert_encoding($value, $to, $from);
     }

Here is the caller graph for this function:

◆ convertToNumberIfFraction()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::convertToNumberIfFraction ( & $operand )

static

Identify whether a string contains a fractional numeric value, and convert it to a numeric if it is.

Parameters

string $operand string value to test

Returns: bool

Definition at line 563 of file StringHelper.php.

References PhpOffice\PhpSpreadsheet\Calculation\Calculation\getInstance().

Referenced by PhpOffice\PhpSpreadsheet\Shared\JAMA\Matrix\arrayRightDivide(), PhpOffice\PhpSpreadsheet\Shared\JAMA\Matrix\arrayTimesEquals(), PhpOffice\PhpSpreadsheet\Shared\JAMA\Matrix\minusEquals(), PhpOffice\PhpSpreadsheet\Shared\JAMA\Matrix\plusEquals(), PhpOffice\PhpSpreadsheet\Shared\JAMA\Matrix\power(), and PhpOffice\PhpSpreadsheet\Calculation\Calculation\validateBinaryOperand().

     {
         if (preg_match('/^' . self::STRING_REGEXP_FRACTION . '$/i', $operand, $match)) {
             $sign = ($match[1] == '-') ? '-' : '+';
             $fractionFormula = '=' . $sign . $match[2] . $sign . $match[3];
             $operand = Calculation::getInstance()->_calculateFormulaValue($fractionFormula);
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countCharacters()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::countCharacters	(	$value,
		$enc = `'UTF-8'`
	)

static

Get character count.

Parameters

string	$value
string	$enc	Encoding

Returns: int Character count

Definition at line 465 of file StringHelper.php.

     {
         return mb_strlen($value ?? '', $enc);
     }

Here is the caller graph for this function:

◆ formatNumber()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::formatNumber ( $value )

static

Formats a numeric value as a string for output in various output writers forcing point as decimal separator in case locale is other than English.

Parameters

mixed $value

Returns: string

Definition at line 370 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generatePageDeclarations(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCellFormula(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCols(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeFont(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writePageMargins(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetData(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetFormatPr().

     {
         if (is_float($value)) {
             return str_replace(',', '.', $value);
         }
 
         return (string) $value;
     }

Here is the caller graph for this function:

◆ getCurrencyCode()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::getCurrencyCode ( )

static

Get the currency code.

If it has not yet been set explicitly, try to obtain the symbol information from locale.

Returns: string

Definition at line 650 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\bindValue(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\NumberFormatter\format(), and PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\VALUE().

     {
         if (!empty(self::$currencyCode)) {
             return self::$currencyCode;
         }
         self::$currencyCode = '$';
         $localeconv = localeconv();
         if (!empty($localeconv['currency_symbol'])) {
             self::$currencyCode = $localeconv['currency_symbol'];
 
             return self::$currencyCode;
         }
         if (!empty($localeconv['int_curr_symbol'])) {
             self::$currencyCode = $localeconv['int_curr_symbol'];
 
             return self::$currencyCode;
         }
 
         return self::$currencyCode;
     }

Here is the caller graph for this function:

◆ getDecimalSeparator()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::getDecimalSeparator ( )

static

Get the decimal separator.

If it has not yet been set explicitly, try to obtain number formatting information from locale.

Returns: string

Definition at line 584 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\bindValue(), PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\FIXEDFORMAT(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\NumberFormatter\formatStraightNumericValue(), and PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\NUMBERVALUE().

     {
         if (!isset(self::$decimalSeparator)) {
             $localeconv = localeconv();
             self::$decimalSeparator = ($localeconv['decimal_point'] != '')
                 ? $localeconv['decimal_point'] : $localeconv['mon_decimal_point'];
 
             if (self::$decimalSeparator == '') {
                 // Default to .
                 self::$decimalSeparator = '.';
             }
         }
 
         return self::$decimalSeparator;
     }

Here is the caller graph for this function:

◆ getIsIconvEnabled()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::getIsIconvEnabled ( )

static

Get whether iconv extension is available.

Returns: bool

Definition at line 247 of file StringHelper.php.

     {
         if (isset(self::$isIconvEnabled)) {
             return self::$isIconvEnabled;
         }
 
         // Assume no problems with iconv
         self::$isIconvEnabled = true;
 
         // Fail if iconv doesn't exist
         if (!function_exists('iconv')) {
             self::$isIconvEnabled = false;
         } elseif (!@iconv('UTF-8', 'UTF-16LE', 'x')) {
             // Sometimes iconv is not working, and e.g. iconv('UTF-8', 'UTF-16LE', 'x') just returns false,
             self::$isIconvEnabled = false;
         } elseif (defined('PHP_OS') && @stristr(PHP_OS, 'AIX') && defined('ICONV_IMPL') && (@strcasecmp(ICONV_IMPL, 'unknown') == 0) && defined('ICONV_VERSION') && (@strcasecmp(ICONV_VERSION, 'unknown') == 0)) {
             // CUSTOM: IBM AIX iconv() does not work
             self::$isIconvEnabled = false;
         }
 
         // Deactivate iconv default options if they fail (as seen on IMB i)
         if (self::$isIconvEnabled && !@iconv('UTF-8', 'UTF-16LE' . self::$iconvOptions, 'x')) {
             self::$iconvOptions = '';
         }
 
         return self::$isIconvEnabled;
     }

◆ getThousandsSeparator()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::getThousandsSeparator ( )

static

Get the thousands separator.

If it has not yet been set explicitly, try to obtain number formatting information from locale.

Returns: string

Definition at line 617 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\bindValue(), PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\FIXEDFORMAT(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\NumberFormatter\formatStraightNumericValue(), PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\NUMBERVALUE(), and PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\VALUE().

     {
         if (!isset(self::$thousandsSeparator)) {
             $localeconv = localeconv();
             self::$thousandsSeparator = ($localeconv['thousands_sep'] != '')
                 ? $localeconv['thousands_sep'] : $localeconv['mon_thousands_sep'];
 
             if (self::$thousandsSeparator == '') {
                 // Default to .
                 self::$thousandsSeparator = ',';
             }
         }
 
         return self::$thousandsSeparator;
     }

Here is the caller graph for this function:

◆ isUTF8()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::isUTF8 ( $value )

static

Check if a string contains UTF8 data.

Parameters

string $value

Returns: bool

Definition at line 357 of file StringHelper.php.

     {
         return $value === '' || preg_match('/^./su', $value) === 1;
     }

◆ mbIsUpper()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::mbIsUpper ( $char )

static

Definition at line 521 of file StringHelper.php.

     {
         return mb_strtolower($char, 'UTF-8') != $char;
     }

◆ mbStrSplit()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::mbStrSplit ( $string )

static

Definition at line 526 of file StringHelper.php.

     {
         // Split at all position not after the start: ^
         // and not before the end: $
         return preg_split('/(?<!^)(?!$)/u', $string);
     }

◆ sanitizeUTF8()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::sanitizeUTF8 ( $value )

static

Try to sanitize UTF8, stripping invalid byte sequences.

Not perfect. Does not surrogate characters.

Parameters

string $value

Returns: string

Definition at line 337 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\StringValueBinder\bindValue(), PhpOffice\PhpSpreadsheet\Cell\DefaultValueBinder\bindValue(), and PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\bindValue().

     {
         if (self::getIsIconvEnabled()) {
             $value = @iconv('UTF-8', 'UTF-8', $value);
 
             return $value;
         }
 
         $value = mb_convert_encoding($value, 'UTF-8', 'UTF-8');
 
         return $value;
     }

Here is the caller graph for this function:

◆ setCurrencyCode()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::setCurrencyCode ( $pValue )

static

Set the currency code.

Only used by NumberFormat::toFormattedString() to format output by and .

Parameters

string $pValue Character for currency code

Definition at line 677 of file StringHelper.php.

                                                    : void
     {
         self::$currencyCode = $pValue;
     }

◆ setDecimalSeparator()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::setDecimalSeparator ( $pValue )

static

Set the decimal separator.

Only used by NumberFormat::toFormattedString() to format output by and .

Parameters

string $pValue Character for decimal separator

Definition at line 606 of file StringHelper.php.

                                                        : void
     {
         self::$decimalSeparator = $pValue;
     }

◆ setThousandsSeparator()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::setThousandsSeparator ( $pValue )

static

Set the thousands separator.

Only used by NumberFormat::toFormattedString() to format output by and .

Parameters

string $pValue Character for thousands separator

Definition at line 639 of file StringHelper.php.

                                                          : void
     {
         self::$thousandsSeparator = $pValue;
     }

◆ strCaseReverse()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::strCaseReverse ( $pValue )

static

Reverse the case of a string, so that all uppercase characters become lowercase and all lowercase characters become uppercase.

Parameters

string $pValue UTF-8 encoded string

Returns: string

Definition at line 541 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Calculation\strcmpLowercaseFirst().

     {
         $characters = self::mbStrSplit($pValue);
         foreach ($characters as &$character) {
             if (self::mbIsUpper($character)) {
                 $character = mb_strtolower($character, 'UTF-8');
             } else {
                 $character = mb_strtoupper($character, 'UTF-8');
             }
         }
 
         return implode('', $characters);
     }

Here is the caller graph for this function:

◆ strToLower()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::strToLower ( $pValue )

static

Convert a UTF-8 encoded string to lower case.

Parameters

string $pValue UTF-8 encoded string

Returns: string

Definition at line 503 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\LookupRef\HLookup\hLookupSearch(), PhpOffice\PhpSpreadsheet\Calculation\TextData\CaseConvert\lower(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\ExcelMatch\MATCH(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\ExcelMatch\prepareLookupArray(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\VLookup\vLookupSearch(), and PhpOffice\PhpSpreadsheet\Calculation\LookupRef\VLookup\vlookupSort().

     {
         return mb_convert_case($pValue, MB_CASE_LOWER, 'UTF-8');
     }

Here is the caller graph for this function:

◆ strToTitle()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::strToTitle ( $pValue )

static

Convert a UTF-8 encoded string to title/proper case (uppercase every first character in each word, lower case all other characters).

Parameters

string $pValue UTF-8 encoded string

Returns: string

Definition at line 516 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\TextData\CaseConvert\proper().

     {
         return mb_convert_case($pValue, MB_CASE_TITLE, 'UTF-8');
     }

Here is the caller graph for this function:

◆ strToUpper()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::strToUpper ( $pValue )

static

Convert a UTF-8 encoded string to upper case.

Parameters

string $pValue UTF-8 encoded string

Returns: string

Definition at line 491 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addDefinedName(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\executeBinaryComparisonOperation(), PhpOffice\PhpSpreadsheet\Spreadsheet\getDefinedName(), PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedFormula(), PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedRange(), PhpOffice\PhpSpreadsheet\Spreadsheet\removeDefinedName(), and PhpOffice\PhpSpreadsheet\Calculation\TextData\CaseConvert\upper().

     {
         return mb_convert_case($pValue, MB_CASE_UPPER, 'UTF-8');
     }

Here is the caller graph for this function:

◆ substring()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::substring	(	$pValue,
		$pStart,
		$pLength = `0`
	)

static

Get a substring of a UTF-8 encoded string.

Parameters

string	$pValue	UTF-8 encoded string
int	$pStart	Start offset
int	$pLength	Maximum number of characters in substring

Returns: string

Definition at line 479 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\checkSheetCodeName(), PhpOffice\PhpSpreadsheet\Cell\DataType\checkString(), PhpOffice\PhpSpreadsheet\Reader\Xls\readLabelSst(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\setCodeName(), and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\setTitle().

     {
         return mb_substr($pValue, $pStart, $pLength, 'UTF-8');
     }

Here is the caller graph for this function:

◆ SYLKtoUTF8()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::SYLKtoUTF8 ( $pValue )

static

Convert SYLK encoded string to UTF-8.

Parameters

string $pValue

Returns: string UTF-8 encoded string

Definition at line 689 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Slk\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Slk\loadIntoExisting().

     {
         self::buildCharacterSets();
 
         // If there is no escape character in the string there is nothing to do
         if (strpos($pValue, '') === false) {
             return $pValue;
         }
 
         foreach (self::$SYLKCharacters as $k => $v) {
             $pValue = str_replace($k, $v, $pValue);
         }
 
         return $pValue;
     }

Here is the caller graph for this function:

◆ testStringAsNumeric()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::testStringAsNumeric ( $value )

static

Retrieve any leading numeric part of a string, or return the full string if no leading numeric (handles basic integer or float, but not exponent or non decimal).

Parameters

string $value

Returns: mixed string or only the leading numeric part of the string

Definition at line 713 of file StringHelper.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Date\getDay(), PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Date\getMonth(), and PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Date\getYear().

     {
         if (is_numeric($value)) {
             return $value;
         }
         $v = (float) $value;
 
         return (is_numeric(substr($value, 0, strlen($v)))) ? $v : $value;
     }

Here is the caller graph for this function:

◆ UTF8toBIFF8UnicodeLong()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::UTF8toBIFF8UnicodeLong ( $value )

static

Converts a UTF-8 string into BIFF8 Unicode string data (16-bit string length) Writes the string using uncompressed notation, no rich text, no Asian phonetics If mbstring extension is not available, ASCII is assumed, and compressed notation is used although this will give wrong results for non-ASCII strings see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect.

2.5.3.

Parameters

string $value UTF-8 encoded string

Returns: string

Definition at line 425 of file StringHelper.php.

     {
         // character count
         $ln = self::countCharacters($value, 'UTF-8');
 
         // characters
         $chars = self::convertEncoding($value, 'UTF-16LE', 'UTF-8');
 
         return pack('vC', $ln, 0x0001) . $chars;
     }

Here is the caller graph for this function:

◆ UTF8toBIFF8UnicodeShort()

static PhpOffice\PhpSpreadsheet\Shared\StringHelper::UTF8toBIFF8UnicodeShort	(	$value,
		$arrcRuns = `[]`
	)

static

Converts a UTF-8 string into BIFF8 Unicode string data (8-bit string length) Writes the string using uncompressed notation, no rich text, no Asian phonetics If mbstring extension is not available, ASCII is assumed, and compressed notation is used although this will give wrong results for non-ASCII strings see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect.

2.5.3.

Parameters

string	$value	UTF-8 encoded string
	mixed[]	$arrcRuns Details of rich text runs in $value

Returns: string

Definition at line 391 of file StringHelper.php.

References $data.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\calcSheetOffsets(), PhpOffice\PhpSpreadsheet\Writer\Xls\Parser\convertString(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\writeBoundSheet(), PhpOffice\PhpSpreadsheet\Writer\Xls\Font\writeFont(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeRichTextString().

     {
         // character count
         $ln = self::countCharacters($value, 'UTF-8');
         // option flags
         if (empty($arrcRuns)) {
             $data = pack('CC', $ln, 0x0001);
             // characters
             $data .= self::convertEncoding($value, 'UTF-16LE', 'UTF-8');
         } else {
             $data = pack('vC', $ln, 0x09);
             $data .= pack('v', count($arrcRuns));
             // characters
             $data .= self::convertEncoding($value, 'UTF-16LE', 'UTF-8');
             foreach ($arrcRuns as $cRun) {
                 $data .= pack('v', $cRun['strlen']);
                 $data .= pack('v', $cRun['fontidx']);
             }
         }
 
         return $data;
     }

Here is the caller graph for this function:

Field Documentation

◆ $controlCharacters

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$controlCharacters = []

staticprivate

Definition at line 19 of file StringHelper.php.

◆ $currencyCode

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$currencyCode

staticprivate

Definition at line 47 of file StringHelper.php.

◆ $decimalSeparator

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$decimalSeparator

staticprivate

Definition at line 33 of file StringHelper.php.

◆ $iconvOptions

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$iconvOptions = '//IGNORE//TRANSLIT'

staticprivate

Definition at line 61 of file StringHelper.php.

◆ $isIconvEnabled

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$isIconvEnabled

staticprivate

Definition at line 54 of file StringHelper.php.

◆ $SYLKCharacters

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$SYLKCharacters = []

staticprivate

Definition at line 26 of file StringHelper.php.

◆ $thousandsSeparator

PhpOffice\PhpSpreadsheet\Shared\StringHelper::$thousandsSeparator

staticprivate

Definition at line 40 of file StringHelper.php.

◆ STRING_REGEXP_FRACTION

const PhpOffice\PhpSpreadsheet\Shared\StringHelper::STRING_REGEXP_FRACTION = '(-?)(\d+)\s+(\d+\/\d+)'

Constants.

Regular Expressions

Definition at line 12 of file StringHelper.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Shared/StringHelper.php

Static Public Member Functions

Data Fields

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ buildCharacterSets()

◆ buildControlCharacters()

◆ buildSYLKCharacters()

◆ controlCharacterOOXML2PHP()

Excel 2007 team:

◆ controlCharacterPHP2OOXML()

Excel 2007 team:

◆ convertEncoding()

◆ convertToNumberIfFraction()

◆ countCharacters()

◆ formatNumber()

◆ getCurrencyCode()

◆ getDecimalSeparator()

◆ getIsIconvEnabled()

◆ getThousandsSeparator()

◆ isUTF8()

◆ mbIsUpper()

◆ mbStrSplit()

◆ sanitizeUTF8()

◆ setCurrencyCode()

◆ setDecimalSeparator()

◆ setThousandsSeparator()

◆ strCaseReverse()

◆ strToLower()

◆ strToTitle()

◆ strToUpper()

◆ substring()

◆ SYLKtoUTF8()

◆ testStringAsNumeric()

◆ UTF8toBIFF8UnicodeLong()

◆ UTF8toBIFF8UnicodeShort()

Field Documentation

◆ $controlCharacters

◆ $currencyCode

◆ $decimalSeparator

◆ $iconvOptions

◆ $isIconvEnabled

◆ $SYLKCharacters

◆ $thousandsSeparator

◆ STRING_REGEXP_FRACTION