\PhpOffice\PhpSpreadsheet\SharedStringHelper

getIsIconvEnabled()

getIsIconvEnabled() : boolean

Get whether iconv extension is available.

Returns

controlCharacterOOXML2PHP()

controlCharacterOOXML2PHP(string  $value) : string

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 () element or in the shared string element.

Parameters

Returns

controlCharacterPHP2OOXML()

controlCharacterPHP2OOXML(string  $value) : string

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 () element or in the shared string element.

Parameters

Returns

sanitizeUTF8()

sanitizeUTF8(string  $value) : string

Try to sanitize UTF8, stripping invalid byte sequences. Not perfect. Does not surrogate characters.

Parameters

Returns

isUTF8()

isUTF8(string  $value) : boolean

Check if a string contains UTF8 data.

Parameters

Returns

formatNumber()

formatNumber(mixed  $value) : string

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

Returns

UTF8toBIFF8UnicodeShort()

UTF8toBIFF8UnicodeShort(string  $value, array<mixed,mixed>  $arrcRuns = array()) : string

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

Returns

UTF8toBIFF8UnicodeLong()

UTF8toBIFF8UnicodeLong(string  $value) : string

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

Returns

convertEncoding()

convertEncoding(string  $value, string  $to, string  $from) : string

Convert string from one encoding to another.

Parameters

Returns

countCharacters()

countCharacters(string  $value, string  $enc = 'UTF-8') : integer

Get character count.

Parameters

Returns

Character count

substring()

substring(string  $pValue, integer  $pStart, integer  $pLength) : string

Get a substring of a UTF-8 encoded string.

Parameters

Returns

strToUpper()

strToUpper(string  $pValue) : string

Convert a UTF-8 encoded string to upper case.

Parameters

Returns

strToLower()

strToLower(string  $pValue) : string

Convert a UTF-8 encoded string to lower case.

Parameters

Returns

strToTitle()

strToTitle(string  $pValue) : string

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

Parameters

Returns

mbIsUpper()

mbIsUpper(  $char) 

Parameters

mbStrSplit()

mbStrSplit(  $string) 

Parameters

strCaseReverse()

strCaseReverse(string  $pValue) : string

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

Parameters

Returns

convertToNumberIfFraction()

convertToNumberIfFraction(  $operand) : boolean

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

Parameters

Returns

getDecimalSeparator()

getDecimalSeparator() : string

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

Returns

setDecimalSeparator()

setDecimalSeparator(string  $pValue) 

Set the decimal separator. Only used by NumberFormat::toFormattedString() to format output by \PhpOffice\PhpSpreadsheet\Writer\Html and \PhpOffice\PhpSpreadsheet\Writer\Pdf.

Parameters

getThousandsSeparator()

getThousandsSeparator() : string

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

Returns

setThousandsSeparator()

setThousandsSeparator(string  $pValue) 

Set the thousands separator. Only used by NumberFormat::toFormattedString() to format output by \PhpOffice\PhpSpreadsheet\Writer\Html and \PhpOffice\PhpSpreadsheet\Writer\Pdf.

Parameters

getCurrencyCode()

getCurrencyCode() : string

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

Returns

setCurrencyCode()

setCurrencyCode(string  $pValue) 

Set the currency code. Only used by NumberFormat::toFormattedString() to format output by \PhpOffice\PhpSpreadsheet\Writer\Html and \PhpOffice\PhpSpreadsheet\Writer\Pdf.

Parameters

SYLKtoUTF8()

SYLKtoUTF8(string  $pValue) : string

Convert SYLK encoded string to UTF-8.

Parameters

Returns

UTF-8 encoded string

testStringAsNumeric()

testStringAsNumeric(string  $value) : mixed

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

Returns

string or only the leading numeric part of the string

buildControlCharacters()

buildControlCharacters() 

Build control characters array.

buildSYLKCharacters()

buildSYLKCharacters() 

Build SYLK characters array.

buildCharacterSets()

buildCharacterSets()