Collaboration diagram for PHPExcel_Shared_String:

Static Public Member Functions
static	getIsMbstringEnabled ()
	Get whether mbstring extension is available. More...

static	getIsIconvEnabled ()
	Get whether iconv extension is available. More...

static	buildCharacterSets ()

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=array())
	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	utf16_decode ($str, $bom_be=TRUE)
	Decode UTF-16 encoded strings. More...

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

static	Substring ($pValue='', $pStart=0, $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	mb_is_upper ($char)

static	mb_str_split ($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 ()

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 Private Attributes
static	$_controlCharacters = array()

static	$_SYLKCharacters = array()
	SYLK Characters array. More...

static	$_decimalSeparator

static	$_thousandsSeparator

static	$_currencyCode

static	$_isMbstringEnabled

static	$_isIconvEnabled

Detailed Description

Definition at line 36 of file String.php.

Member Function Documentation

◆ _buildControlCharacters()

static PHPExcel_Shared_String::_buildControlCharacters ( )

staticprivate

Build control characters array.

Definition at line 96 of file String.php.

                                                          {
                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;
                        }
                }
        }

References sprintf.

Referenced by buildCharacterSets().

Here is the caller graph for this function:

◆ _buildSYLKCharacters()

static PHPExcel_Shared_String::_buildSYLKCharacters ( )

staticprivate

Build SYLK characters array.

Definition at line 109 of file String.php.

        {
                self::$_SYLKCharacters = array(
                        "\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
                );
        }

Referenced by buildCharacterSets().

Here is the caller graph for this function:

◆ buildCharacterSets()

static PHPExcel_Shared_String::buildCharacterSets ( )

static

Definition at line 332 of file String.php.

                                                    {
                if(empty(self::$_controlCharacters)) {
                        self::_buildControlCharacters();
                }
                if(empty(self::$_SYLKCharacters)) {
                        self::_buildSYLKCharacters();
                }
        }

References _buildControlCharacters(), and _buildSYLKCharacters().

Here is the call graph for this function:

◆ ControlCharacterOOXML2PHP()

static PHPExcel_Shared_String::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 355 of file String.php.

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

Referenced by PHPExcel_Reader_Excel2007\_parseRichText(), and PHPExcel_Reader_Excel2007\load().

Here is the caller graph for this function:

◆ ControlCharacterPHP2OOXML()

static PHPExcel_Shared_String::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 373 of file String.php.

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

Referenced by PHPExcel_Writer_Excel2007_Chart\_writeCatAx(), PHPExcel_Writer_Excel2007_Worksheet\_writeCell(), PHPExcel_Writer_Excel2007_Chart\_writeValAx(), PHPExcel_Writer_Excel2007_StringTable\writeRichText(), PHPExcel_Writer_Excel2007_StringTable\writeRichTextForCharts(), and PHPExcel_Writer_Excel2007_StringTable\writeStringTable().

Here is the caller graph for this function:

◆ ConvertEncoding()

static PHPExcel_Shared_String::ConvertEncoding	(	$value,
		$to,
		$from
	)

static

Convert string from one encoding to another.

First try mbstring, then iconv, finally strlen

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 493 of file String.php.

        {
                if (self::getIsIconvEnabled()) {
                        return iconv($from, $to, $value);
                }
 
                if (self::getIsMbstringEnabled()) {
                        return mb_convert_encoding($value, $to, $from);
                }
 
                if($from == 'UTF-16LE'){
                        return self::utf16_decode($value, false);
                }else if($from == 'UTF-16BE'){
                        return self::utf16_decode($value);
                }
                // else, no conversion
                return $value;
        }

References utf16_decode().

Referenced by PHPExcel_Reader_Excel2003XML\_convertStringEncoding(), PHPExcel_Reader_Excel5\_decodeCodepage(), PHPExcel_Reader_Excel5\_encodeUTF16(), PHPExcel_Reader_Excel5\_readDocumentSummaryInformation(), PHPExcel_Reader_Excel5\_readSummaryInformation(), PHPExcel_Writer_Excel5_Worksheet\_writeUrlInternal(), PHPExcel_Reader_CSV\loadIntoExisting(), UTF8toBIFF8UnicodeLong(), and UTF8toBIFF8UnicodeShort().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertToNumberIfFraction()

static PHPExcel_Shared_String::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: boolean

Definition at line 671 of file String.php.

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

References PHPExcel_Calculation\getInstance().

Referenced by PHPExcel_Calculation\_validateBinaryOperand(), PHPExcel_Shared_JAMA_Matrix\arrayRightDivide(), PHPExcel_Shared_JAMA_Matrix\arrayTimesEquals(), PHPExcel_Shared_JAMA_Matrix\minusEquals(), PHPExcel_Shared_JAMA_Matrix\plusEquals(), and PHPExcel_Shared_JAMA_Matrix\power().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CountCharacters()

static PHPExcel_Shared_String::CountCharacters	(	$value,
		$enc = `'UTF-8'`
	)

static

Get character count.

First try mbstring, then iconv, finally strlen

Parameters

string	$value
string	$enc	Encoding

Returns: int Character count

Definition at line 550 of file String.php.

        {
                if (self::getIsMbstringEnabled()) {
                        return mb_strlen($value, $enc);
                }
 
                if (self::getIsIconvEnabled()) {
                        return iconv_strlen($value, $enc);
                }
 
                // else strlen
                return strlen($value);
        }

Referenced by PHPExcel_Worksheet\_checkSheetCodeName(), PHPExcel_Worksheet\_checkSheetTitle(), PHPExcel_Reader_Excel5\_readLabelSst(), PHPExcel_Writer_Excel5_Worksheet\_writeUrlInternal(), PHPExcel_Writer_Excel5_Worksheet\close(), PHPExcel_Shared_Font\getTextWidthPixelsApprox(), PHPExcel_Calculation_TextData\SEARCHINSENSITIVE(), PHPExcel_Calculation_TextData\SEARCHSENSITIVE(), PHPExcel_Worksheet\setCodeName(), PHPExcel_Worksheet\setTitle(), UTF8toBIFF8UnicodeLong(), and UTF8toBIFF8UnicodeShort().

Here is the caller graph for this function:

◆ FormatNumber()

static PHPExcel_Shared_String::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 416 of file String.php.

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

Referenced by PHPExcel_Writer_HTML\_setMargins(), PHPExcel_Writer_Excel2007_Worksheet\_writeCell(), PHPExcel_Writer_Excel2007_Worksheet\_writeCols(), PHPExcel_Writer_Excel2007_Worksheet\_writePageMargins(), PHPExcel_Writer_Excel2007_Worksheet\_writeSheetData(), and PHPExcel_Writer_Excel2007_Worksheet\_writeSheetFormatPr().

Here is the caller graph for this function:

◆ getCurrencyCode()

static PHPExcel_Shared_String::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 751 of file String.php.

        {
                if (!isset(self::$_currencyCode)) {
                        $localeconv = localeconv();
                        self::$_currencyCode = ($localeconv['currency_symbol'] != '')
                                ? $localeconv['currency_symbol'] : $localeconv['int_curr_symbol'];
 
                        if (self::$_currencyCode == '') {
                                // Default to $
                                self::$_currencyCode = '$';
                        }
                }
                return self::$_currencyCode;
        }

References $_currencyCode.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), PHPExcel_Style_NumberFormat\toFormattedString(), and PHPExcel_Calculation_TextData\VALUE().

Here is the caller graph for this function:

◆ getDecimalSeparator()

static PHPExcel_Shared_String::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 687 of file String.php.

        {
                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;
        }

References $_decimalSeparator.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), and PHPExcel_Style_NumberFormat\toFormattedString().

Here is the caller graph for this function:

◆ getIsIconvEnabled()

static PHPExcel_Shared_String::getIsIconvEnabled ( )

static

Get whether iconv extension is available.

Returns: boolean

Definition at line 293 of file String.php.

        {
                if (isset(self::$_isIconvEnabled)) {
                        return self::$_isIconvEnabled;
                }
 
                // Fail if iconv doesn't exist
                if (!function_exists('iconv')) {
                        self::$_isIconvEnabled = false;
                        return false;
                }
 
                // Sometimes iconv is not working, and e.g. iconv('UTF-8', 'UTF-16LE', 'x') just returns false,
                if (!@iconv('UTF-8', 'UTF-16LE', 'x')) {
                        self::$_isIconvEnabled = false;
                        return false;
                }
 
                // Sometimes iconv_substr('A', 0, 1, 'UTF-8') just returns false in PHP 5.2.0
                // we cannot use iconv in that case either (http://bugs.php.net/bug.php?id=37773)
                if (!@iconv_substr('A', 0, 1, 'UTF-8')) {
                        self::$_isIconvEnabled = false;
                        return false;
                }
 
                // CUSTOM: IBM AIX iconv() does not work
                if ( defined('PHP_OS') && @stristr(PHP_OS, 'AIX')
                                && defined('ICONV_IMPL') && (@strcasecmp(ICONV_IMPL, 'unknown') == 0)
                                && defined('ICONV_VERSION') && (@strcasecmp(ICONV_VERSION, 'unknown') == 0) )
                {
                        self::$_isIconvEnabled = false;
                        return false;
                }
 
                // If we reach here no problems were detected with iconv
                self::$_isIconvEnabled = true;
                return true;
        }

References $_isIconvEnabled, and defined.

Referenced by UTF8toBIFF8UnicodeLong(), and UTF8toBIFF8UnicodeShort().

Here is the caller graph for this function:

◆ getIsMbstringEnabled()

static PHPExcel_Shared_String::getIsMbstringEnabled ( )

static

Get whether mbstring extension is available.

Returns: boolean

Definition at line 276 of file String.php.

        {
                if (isset(self::$_isMbstringEnabled)) {
                        return self::$_isMbstringEnabled;
                }
 
                self::$_isMbstringEnabled = function_exists('mb_convert_encoding') ?
                        true : false;
 
                return self::$_isMbstringEnabled;
        }

References $_isMbstringEnabled.

Referenced by UTF8toBIFF8UnicodeLong(), and UTF8toBIFF8UnicodeShort().

Here is the caller graph for this function:

◆ getThousandsSeparator()

static PHPExcel_Shared_String::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 719 of file String.php.

        {
                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;
        }

References $_thousandsSeparator.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), PHPExcel_Style_NumberFormat\toFormattedString(), and PHPExcel_Calculation_TextData\VALUE().

Here is the caller graph for this function:

◆ IsUTF8()

static PHPExcel_Shared_String::IsUTF8 ( $value = '' )

static

Check if a string contains UTF8 data.

Parameters

string $value

Returns: boolean

Definition at line 405 of file String.php.

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

◆ mb_is_upper()

static PHPExcel_Shared_String::mb_is_upper ( $char )

static

Definition at line 629 of file String.php.

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

◆ mb_str_split()

static PHPExcel_Shared_String::mb_str_split ( $string )

static

Definition at line 634 of file String.php.

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

Referenced by StrCaseReverse().

Here is the caller graph for this function:

◆ SanitizeUTF8()

static PHPExcel_Shared_String::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 383 of file String.php.

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

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), and PHPExcel_Cell_DefaultValueBinder\bindValue().

Here is the caller graph for this function:

◆ setCurrencyCode()

static PHPExcel_Shared_String::setCurrencyCode ( $pValue = '$' )

static

Set the currency code.

Only used by PHPExcel_Style_NumberFormat::toFormattedString() to format output by PHPExcel_Writer_HTML and PHPExcel_Writer_PDF

Parameters

string $pValue Character for currency code

Definition at line 772 of file String.php.

        {
                self::$_currencyCode = $pValue;
        }

Referenced by AdvancedValueBinderTest\testCurrency().

Here is the caller graph for this function:

◆ setDecimalSeparator()

static PHPExcel_Shared_String::setDecimalSeparator ( $pValue = '.' )

static

Set the decimal separator.

Only used by PHPExcel_Style_NumberFormat::toFormattedString() to format output by PHPExcel_Writer_HTML and PHPExcel_Writer_PDF

Parameters

string $pValue Character for decimal separator

Definition at line 708 of file String.php.

        {
                self::$_decimalSeparator = $pValue;
        }

Referenced by NumberFormatTest\setUp(), and AdvancedValueBinderTest\testCurrency().

Here is the caller graph for this function:

◆ setThousandsSeparator()

static PHPExcel_Shared_String::setThousandsSeparator ( $pValue = ',' )

static

Set the thousands separator.

Only used by PHPExcel_Style_NumberFormat::toFormattedString() to format output by PHPExcel_Writer_HTML and PHPExcel_Writer_PDF

Parameters

string $pValue Character for thousands separator

Definition at line 740 of file String.php.

        {
                self::$_thousandsSeparator = $pValue;
        }

Referenced by NumberFormatTest\setUp(), and AdvancedValueBinderTest\testCurrency().

Here is the caller graph for this function:

◆ StrCaseReverse()

static PHPExcel_Shared_String::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 648 of file String.php.

        {
        if (self::getIsMbstringEnabled()) {
            $characters = self::mb_str_split($pValue);
            foreach($characters as &$character) {
                if(self::mb_is_upper($character)) {
                    $character = mb_strtolower($character, 'UTF-8');
                } else {
                    $character = mb_strtoupper($character, 'UTF-8');
                }
            }
            return implode('', $characters);
                }
                return strtolower($pValue) ^ strtoupper($pValue) ^ $pValue;
        }

References mb_str_split().

Referenced by PHPExcel_Calculation\strcmpLowercaseFirst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StrToLower()

static PHPExcel_Shared_String::StrToLower ( $pValue = '' )

static

Convert a UTF-8 encoded string to lower case.

Parameters

string $pValue UTF-8 encoded string

Returns: string

Definition at line 606 of file String.php.

        {
                if (function_exists('mb_convert_case')) {
                        return mb_convert_case($pValue, MB_CASE_LOWER, "UTF-8");
                }
                return strtolower($pValue);
        }

Referenced by PHPExcel_Calculation_TextData\LOWERCASE().

Here is the caller graph for this function:

◆ StrToTitle()

static PHPExcel_Shared_String::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 621 of file String.php.

        {
                if (function_exists('mb_convert_case')) {
                        return mb_convert_case($pValue, MB_CASE_TITLE, "UTF-8");
                }
                return ucwords($pValue);
        }

Referenced by PHPExcel_Calculation_TextData\PROPERCASE().

Here is the caller graph for this function:

◆ StrToUpper()

static PHPExcel_Shared_String::StrToUpper ( $pValue = '' )

static

Convert a UTF-8 encoded string to upper case.

Parameters

string $pValue UTF-8 encoded string

Returns: string

Definition at line 592 of file String.php.

        {
                if (function_exists('mb_convert_case')) {
                        return mb_convert_case($pValue, MB_CASE_UPPER, "UTF-8");
                }
                return strtoupper($pValue);
        }

Referenced by PHPExcel_Calculation_TextData\UPPERCASE().

Here is the caller graph for this function:

◆ Substring()

static PHPExcel_Shared_String::Substring	(	$pValue = `''`,
		$pStart = `0`,
		$pLength = `0`
	)

static

Get a substring of a UTF-8 encoded string.

First try mbstring, then iconv, finally strlen

Parameters

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

Returns: string

Definition at line 572 of file String.php.

        {
                if (self::getIsMbstringEnabled()) {
                        return mb_substr($pValue, $pStart, $pLength, 'UTF-8');
                }
 
                if (self::getIsIconvEnabled()) {
                        return iconv_substr($pValue, $pStart, $pLength, 'UTF-8');
                }
 
                // else substr
                return substr($pValue, $pStart, $pLength);
        }

Referenced by PHPExcel_Worksheet\_checkSheetCodeName(), PHPExcel_Reader_Excel5\_readLabelSst(), PHPExcel_Cell_DataType\checkString(), PHPExcel_Worksheet\setCodeName(), and PHPExcel_Worksheet\setTitle().

Here is the caller graph for this function:

◆ SYLKtoUTF8()

static PHPExcel_Shared_String::SYLKtoUTF8 ( $pValue = '' )

static

Convert SYLK encoded string to UTF-8.

Parameters

string $pValue

Returns: string UTF-8 encoded string

Definition at line 783 of file String.php.

        {
                // 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;
        }

Referenced by PHPExcel_Reader_SYLK\listWorksheetInfo(), and PHPExcel_Reader_SYLK\loadIntoExisting().

Here is the caller graph for this function:

◆ testStringAsNumeric()

static PHPExcel_Shared_String::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 804 of file String.php.

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

Referenced by PHPExcel_Calculation_DateTime\DATE().

Here is the caller graph for this function:

◆ utf16_decode()

static PHPExcel_Shared_String::utf16_decode	(	$str,
		$bom_be = `TRUE`
	)

static

Decode UTF-16 encoded strings.

Can handle both BOM'ed data and un-BOM'ed data. Assumes Big-Endian byte order if no BOM is available. This function was taken from http://php.net/manual/en/function.utf8-decode.php and $bom_be parameter added.

Parameters

string $str UTF-16 encoded data to decode.

Returns: string UTF-8 / ISO encoded data. @access public

Version: 0.2 / 2010-05-13

Author: Rasmus Andersson http://rasmusandersson.se/; vadik56

Definition at line 527 of file String.php.

                                                                  {
                if( strlen($str) < 2 ) return $str;
                $c0 = ord($str{0});
                $c1 = ord($str{1});
                if( $c0 == 0xfe && $c1 == 0xff ) { $str = substr($str,2); }
                elseif( $c0 == 0xff && $c1 == 0xfe ) { $str = substr($str,2); $bom_be = false; }
                $len = strlen($str);
                $newstr = '';
                for($i=0;$i<$len;$i+=2) {
                        if( $bom_be ) { $val = ord($str{$i})   << 4; $val += ord($str{$i+1}); }
                        else {        $val = ord($str{$i+1}) << 4; $val += ord($str{$i}); }
                        $newstr .= ($val == 0x228) ? "\n" : chr($val);
                }
                return $newstr;
        }

Referenced by ConvertEncoding().

Here is the caller graph for this function:

◆ UTF8toBIFF8UnicodeLong()

static PHPExcel_Shared_String::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 469 of file String.php.

        {
                // character count
                $ln = self::CountCharacters($value, 'UTF-8');
 
                // option flags
                $opt = (self::getIsIconvEnabled() || self::getIsMbstringEnabled()) ?
                        0x0001 : 0x0000;
 
                // characters
                $chars = self::ConvertEncoding($value, 'UTF-16LE', 'UTF-8');
 
                $data = pack('vC', $ln, $opt) . $chars;
                return $data;
        }

References $data, ConvertEncoding(), CountCharacters(), getIsIconvEnabled(), and getIsMbstringEnabled().

Referenced by PHPExcel_Writer_Excel5_Worksheet\_writeCFRule(), PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity(), PHPExcel_Writer_Excel5_Worksheet\_writeFooter(), PHPExcel_Writer_Excel5_Worksheet\_writeHeader(), PHPExcel_Writer_Excel5_Worksheet\_writeLabelSst(), PHPExcel_Writer_Excel5_Worksheet\_writeRangeProtection(), and PHPExcel_Writer_Excel5_Worksheet\_writeStringRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UTF8toBIFF8UnicodeShort()

static PHPExcel_Shared_String::UTF8toBIFF8UnicodeShort	(	$value,
		$arrcRuns = `array()`
	)

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 434 of file String.php.

        {
                // character count
                $ln = self::CountCharacters($value, 'UTF-8');
                // option flags
                if(empty($arrcRuns)){
                        $opt = (self::getIsIconvEnabled() || self::getIsMbstringEnabled()) ?
                                0x0001 : 0x0000;
                        $data = pack('CC', $ln, $opt);
                        // 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;
        }

References $data, ConvertEncoding(), CountCharacters(), getIsIconvEnabled(), and getIsMbstringEnabled().

Referenced by PHPExcel_Writer_Excel5_Workbook\_calcSheetOffsets(), PHPExcel_Writer_Excel5_Parser\_convertString(), PHPExcel_Writer_Excel5_Worksheet\_writeRichTextString(), and PHPExcel_Writer_Excel5_Font\writeFont().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_controlCharacters

PHPExcel_Shared_String::$_controlCharacters = array()

staticprivate

Definition at line 49 of file String.php.

◆ $_currencyCode

PHPExcel_Shared_String::$_currencyCode

staticprivate

Definition at line 77 of file String.php.

Referenced by getCurrencyCode().

◆ $_decimalSeparator

PHPExcel_Shared_String::$_decimalSeparator

staticprivate

Definition at line 63 of file String.php.

Referenced by getDecimalSeparator().

◆ $_isIconvEnabled

PHPExcel_Shared_String::$_isIconvEnabled

staticprivate

Definition at line 91 of file String.php.

Referenced by getIsIconvEnabled().

◆ $_isMbstringEnabled

PHPExcel_Shared_String::$_isMbstringEnabled

staticprivate

Definition at line 84 of file String.php.

Referenced by getIsMbstringEnabled().

◆ $_SYLKCharacters

PHPExcel_Shared_String::$_SYLKCharacters = array()

staticprivate

SYLK Characters array.

$var array

Definition at line 56 of file String.php.

◆ $_thousandsSeparator

PHPExcel_Shared_String::$_thousandsSeparator

staticprivate

Definition at line 70 of file String.php.

Referenced by getThousandsSeparator().

◆ STRING_REGEXP_FRACTION

const PHPExcel_Shared_String::STRING_REGEXP_FRACTION = '(-?)(\d+)\s+(\d+\/\d+)'

Constants

Regular Expressions

Definition at line 41 of file String.php.

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/String.php

Static Public Member Functions

Data Fields

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ _buildControlCharacters()

◆ _buildSYLKCharacters()

◆ buildCharacterSets()

◆ ControlCharacterOOXML2PHP()

Excel 2007 team:

◆ ControlCharacterPHP2OOXML()

Excel 2007 team:

◆ ConvertEncoding()

◆ convertToNumberIfFraction()

◆ CountCharacters()

◆ FormatNumber()

◆ getCurrencyCode()

◆ getDecimalSeparator()

◆ getIsIconvEnabled()

◆ getIsMbstringEnabled()

◆ getThousandsSeparator()

◆ IsUTF8()

◆ mb_is_upper()

◆ mb_str_split()

◆ SanitizeUTF8()

◆ setCurrencyCode()

◆ setDecimalSeparator()

◆ setThousandsSeparator()

◆ StrCaseReverse()

◆ StrToLower()

◆ StrToTitle()

◆ StrToUpper()

◆ Substring()

◆ SYLKtoUTF8()

◆ testStringAsNumeric()

◆ utf16_decode()

◆ UTF8toBIFF8UnicodeLong()

◆ UTF8toBIFF8UnicodeShort()

Field Documentation

◆ $_controlCharacters

◆ $_currencyCode

◆ $_decimalSeparator

◆ $_isIconvEnabled

◆ $_isMbstringEnabled

◆ $_SYLKCharacters

◆ $_thousandsSeparator

◆ STRING_REGEXP_FRACTION