\PhpOffice\PhpSpreadsheet\CalculationTextData

Summary

Methods

Properties

Constants

CHARACTER()
TRIMNONPRINTABLE()
TRIMSPACES()
ASCIICODE()
CONCATENATE()
DOLLAR()
SEARCHSENSITIVE()
SEARCHINSENSITIVE()
FIXEDFORMAT()
LEFT()
MID()
RIGHT()
STRINGLENGTH()
LOWERCASE()
UPPERCASE()
PROPERCASE()
REPLACE()
SUBSTITUTE()
RETURNSTRING()
TEXTFORMAT()
VALUE()
NUMBERVALUE()
EXACT()
TEXTJOIN()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

unicodeToOrd()
convertBooleanValue()

$invalidChars

N/A

File: vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Calculation/TextData.php
Package: Default
Class hierarchy: \PhpOffice\PhpSpreadsheet\Calculation\TextData

Properties

$invalidChars

$invalidChars :

Type

Methods

CHARACTER()

CHARACTER(string  $character) : string

CHARACTER.

Parameters

string

$character

Value

Returns

string

TRIMNONPRINTABLE()

TRIMNONPRINTABLE(mixed  $stringValue = '') : string

TRIMNONPRINTABLE.

Parameters

mixed

$stringValue

Value to check

Returns

string

TRIMSPACES()

TRIMSPACES(mixed  $stringValue = '') : string

TRIMSPACES.

Parameters

mixed

$stringValue

Value to check

Returns

string

ASCIICODE()

ASCIICODE(string  $characters) : integer

ASCIICODE.

Parameters

string

$characters

Value

Returns

integer

CONCATENATE()

CONCATENATE(  $args) : string

CONCATENATE.

Parameters

$args

Returns

string

DOLLAR()

DOLLAR(float  $value, integer  $decimals = 2) : string

DOLLAR.

This function converts a number to text using currency format, with the decimals rounded to the specified place. The format used is $#,##0.00_);($#,##0.00)..

Parameters

float	$value	The value to format
integer	$decimals	The number of digits to display to the right of the decimal point. If decimals is negative, number is rounded to the left of the decimal point. If you omit decimals, it is assumed to be 2

Returns

string

SEARCHSENSITIVE()

SEARCHSENSITIVE(string  $needle, string  $haystack, integer  $offset = 1) : string

SEARCHSENSITIVE.

Parameters

string	$needle	The string to look for
string	$haystack	The string in which to look
integer	$offset	Offset within $haystack

Returns

string

SEARCHINSENSITIVE()

SEARCHINSENSITIVE(string  $needle, string  $haystack, integer  $offset = 1) : string

SEARCHINSENSITIVE.

Parameters

string	$needle	The string to look for
string	$haystack	The string in which to look
integer	$offset	Offset within $haystack

Returns

string

FIXEDFORMAT()

FIXEDFORMAT(mixed  $value, integer  $decimals = 2, boolean  $no_commas = false) : string

FIXEDFORMAT.

Parameters

mixed	$value	Value to check
integer	$decimals
boolean	$no_commas

Returns

string

LEFT()

LEFT(string  $value = '', integer  $chars = 1) : string

LEFT.

Parameters

string	$value	Value
integer	$chars	Number of characters

Returns

string

MID()

MID(string  $value = '', integer  $start = 1, integer  $chars = null) : string

MID.

Parameters

string	$value	Value
integer	$start	Start character
integer	$chars	Number of characters

Returns

string

RIGHT()

RIGHT(string  $value = '', integer  $chars = 1) : string

RIGHT.

Parameters

string	$value	Value
integer	$chars	Number of characters

Returns

string

STRINGLENGTH()

STRINGLENGTH(string  $value = '') : integer

STRINGLENGTH.

Parameters

string

$value

Value

Returns

integer

LOWERCASE()

LOWERCASE(string  $mixedCaseString) : string

LOWERCASE.

Converts a string value to upper case.

Parameters

string

$mixedCaseString

Returns

string

UPPERCASE()

UPPERCASE(string  $mixedCaseString) : string

UPPERCASE.

Converts a string value to upper case.

Parameters

string

$mixedCaseString

Returns

string

PROPERCASE()

PROPERCASE(string  $mixedCaseString) : string

PROPERCASE.

Converts a string value to upper case.

Parameters

string

$mixedCaseString

Returns

string

REPLACE()

REPLACE(string  $oldText, integer  $start, integer  $chars, string  $newText) : string

REPLACE.

Parameters

string	$oldText	String to modify
integer	$start	Start character
integer	$chars	Number of characters
string	$newText	String to replace in defined position

Returns

string

SUBSTITUTE()

SUBSTITUTE(string  $text = '', string  $fromText = '', string  $toText = '', integer  $instance) : string

SUBSTITUTE.

Parameters

string	$text	Value
string	$fromText	From Value
string	$toText	To Value
integer	$instance	Instance Number

Returns

string

RETURNSTRING()

RETURNSTRING(mixed  $testValue = '') : null|string

RETURNSTRING.

Parameters

mixed

$testValue

Value to check

Returns

null|string

TEXTFORMAT()

TEXTFORMAT(mixed  $value, string  $format) : string

TEXTFORMAT.

Parameters

mixed	$value	Value to check
string	$format	Format mask to use

Returns

string

VALUE()

VALUE(mixed  $value = '') : boolean

VALUE.

Parameters

mixed

$value

Value to check

Returns

boolean

NUMBERVALUE()

NUMBERVALUE(mixed  $value = '', string  $decimalSeparator = null, string  $groupSeparator = null) : float|string

NUMBERVALUE.

Parameters

mixed	$value	Value to check
string	$decimalSeparator	decimal separator, defaults to locale defined value
string	$groupSeparator	group/thosands separator, defaults to locale defined value

Returns

float|string

EXACT()

EXACT(  $value1,   $value2) : boolean

Compares two text strings and returns TRUE if they are exactly the same, FALSE otherwise.

EXACT is case-sensitive but ignores formatting differences. Use EXACT to test text being entered into a document.

Parameters

	$value1
	$value2

Returns

boolean

TEXTJOIN()

TEXTJOIN(mixed  $delimiter, mixed  $ignoreEmpty, mixed  $args) : string

TEXTJOIN.

Parameters

mixed	$delimiter
mixed	$ignoreEmpty
mixed	$args

Returns

string

unicodeToOrd()

unicodeToOrd(  $character)

Parameters

$character

convertBooleanValue()

convertBooleanValue(  $value)

Parameters

$value