Collaboration diagram for PhpOffice\PhpSpreadsheet\Calculation\TextData:

Static Public Member Functions
static	CHARACTER ($character)
	CHARACTER. More...

static	TRIMNONPRINTABLE ($stringValue='')
	TRIMNONPRINTABLE. More...

static	TRIMSPACES ($stringValue='')
	TRIMSPACES. More...

static	ASCIICODE ($characters)
	ASCIICODE. More...

static	CONCATENATE (... $args)
	CONCATENATE. More...

static	DOLLAR ($value=0, $decimals=2)
	DOLLAR. More...

static	SEARCHSENSITIVE ($needle, $haystack, $offset=1)
	SEARCHSENSITIVE. More...

static	SEARCHINSENSITIVE ($needle, $haystack, $offset=1)
	SEARCHINSENSITIVE. More...

static	FIXEDFORMAT ($value, $decimals=2, $no_commas=false)
	FIXEDFORMAT. More...

static	LEFT ($value='', $chars=1)
	LEFT. More...

static	MID ($value='', $start=1, $chars=null)
	MID. More...

static	RIGHT ($value='', $chars=1)
	RIGHT. More...

static	STRINGLENGTH ($value='')
	STRINGLENGTH. More...

static	LOWERCASE ($mixedCaseString)
	LOWERCASE. More...

static	UPPERCASE ($mixedCaseString)
	UPPERCASE. More...

static	PROPERCASE ($mixedCaseString)
	PROPERCASE. More...

static	REPLACE ($oldText, $start, $chars, $newText)
	REPLACE. More...

static	SUBSTITUTE ($text='', $fromText='', $toText='', $instance=0)
	SUBSTITUTE. More...

static	RETURNSTRING ($testValue='')
	RETURNSTRING. More...

static	TEXTFORMAT ($value, $format)
	TEXTFORMAT. More...

static	VALUE ($value='')
	VALUE. More...

static	NUMBERVALUE ($value='', $decimalSeparator=null, $groupSeparator=null)
	NUMBERVALUE. More...

static	EXACT ($value1, $value2)
	Compares two text strings and returns TRUE if they are exactly the same, FALSE otherwise. More...

static	TEXTJOIN ($delimiter, $ignoreEmpty,... $args)
	TEXTJOIN. More...

static	builtinREPT ($str, $number)
	REPT. More...

Detailed Description

Deprecated:: 1.18.0

Definition at line 10 of file TextData.php.

Member Function Documentation

◆ ASCIICODE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::ASCIICODE ( $characters )

static

ASCIICODE.

1.18.0

See also: Use the code() method in the TextData class instead

Parameters

string $characters Value

Returns: int|string A string if arguments are invalid

Definition at line 71 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\CharacterConvert\code().

     {
         return TextData\CharacterConvert::code($characters);
     }

Here is the call graph for this function:

◆ builtinREPT()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::builtinREPT	(	$str,
		$number
	)

static

REPT.

Returns the result of builtin function repeat after validating args.

1.18.0

See also: Use the builtinREPT() method in the TextData class instead

Parameters

string	$str	Should be numeric
mixed	$number	Should be int

Returns: string

Definition at line 444 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Concatenate\builtinREPT().

     {
         return TextData\Concatenate::builtinREPT($str, $number);
     }

Here is the call graph for this function:

◆ CHARACTER()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::CHARACTER ( $character )

static

CHARACTER.

1.18.0

See also: Use the character() method in the TextData class instead

Parameters

string $character Value

Returns: string

Definition at line 23 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\CharacterConvert\character().

     {
         return TextData\CharacterConvert::character($character);
     }

Here is the call graph for this function:

◆ CONCATENATE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::CONCATENATE ( $args )

static

CONCATENATE.

1.18.0

See also: Use the CONCATENATE() method in the TextData class instead

Returns: string

Definition at line 85 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Concatenate\CONCATENATE().

     {
         return TextData\Concatenate::CONCATENATE(...$args);
     }

Here is the call graph for this function:

◆ DOLLAR()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::DOLLAR	(	$value = `0`,
		$decimals = `2`
	)

static

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)..

1.18.0

See also: Use the DOLLAR() method in the TextData class instead

Parameters

float	$value	The value to format
int	$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

Definition at line 107 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\DOLLAR().

     {
         return TextData\Format::DOLLAR($value, $decimals);
     }

Here is the call graph for this function:

◆ EXACT()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::EXACT	(	$value1,
		$value2
	)

static

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.

1.18.0

See also: Use the exact() method in the TextData class instead

Parameters

mixed	$value1
mixed	$value2

Returns: bool

Definition at line 407 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Text\exact().

     {
         return TextData\Text::exact($value1, $value2);
     }

Here is the call graph for this function:

◆ FIXEDFORMAT()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::FIXEDFORMAT	(	$value,
		$decimals = `2`,
		$no_commas = `false`
	)

static

FIXEDFORMAT.

1.18.0

See also: Use the FIXEDFORMAT() method in the TextData class instead

Parameters

mixed	$value	Value to check
int	$decimals
bool	$no_commas

Returns: string

Definition at line 161 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\FIXEDFORMAT().

     {
         return TextData\Format::FIXEDFORMAT($value, $decimals, $no_commas);
     }

Here is the call graph for this function:

◆ LEFT()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::LEFT	(	$value = `''`,
		$chars = `1`
	)

static

LEFT.

1.18.0

See also: Use the left() method in the TextData class instead

Parameters

string	$value	Value
int	$chars	Number of characters

Returns: string

Definition at line 178 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Extract\left().

     {
         return TextData\Extract::left($value, $chars);
     }

Here is the call graph for this function:

◆ LOWERCASE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::LOWERCASE ( $mixedCaseString )

static

LOWERCASE.

Converts a string value to upper case.

1.18.0

See also: Use the lower() method in the TextData class instead

Parameters

string $mixedCaseString

Returns: string

Definition at line 247 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\CaseConvert\lower().

     {
         return TextData\CaseConvert::lower($mixedCaseString);
     }

Here is the call graph for this function:

◆ MID()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::MID	(	$value = `''`,
		$start = `1`,
		$chars = `null`
	)

static

MID.

1.18.0

See also: Use the mid() method in the TextData class instead

Parameters

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

Returns: string

Definition at line 196 of file TextData.php.

References $start, and PhpOffice\PhpSpreadsheet\Calculation\TextData\Extract\mid().

     {
         return TextData\Extract::mid($value, $start, $chars);
     }

Here is the call graph for this function:

◆ NUMBERVALUE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::NUMBERVALUE	(	$value = `''`,
		$decimalSeparator = `null`,
		$groupSeparator = `null`
	)

static

NUMBERVALUE.

1.18.0

See also: Use the NUMBERVALUE() method in the TextData class instead

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

Definition at line 388 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\NUMBERVALUE().

     {
         return TextData\Format::NUMBERVALUE($value, $decimalSeparator, $groupSeparator);
     }

Here is the call graph for this function:

◆ PROPERCASE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::PROPERCASE ( $mixedCaseString )

static

PROPERCASE.

Converts a string value to upper case.

1.18.0

See also: Use the proper() method in the TextData class instead

Parameters

string $mixedCaseString

Returns: string

Definition at line 283 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\CaseConvert\proper().

     {
         return TextData\CaseConvert::proper($mixedCaseString);
     }

Here is the call graph for this function:

◆ REPLACE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::REPLACE	(	$oldText,
		$start,
		$chars,
		$newText
	)

static

REPLACE.

1.18.0

See also: Use the replace() method in the TextData class instead

Parameters

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

Returns: string

Definition at line 302 of file TextData.php.

References $start, and PhpOffice\PhpSpreadsheet\Calculation\TextData\Replace\replace().

     {
         return TextData\Replace::replace($oldText, $start, $chars, $newText);
     }

Here is the call graph for this function:

◆ RETURNSTRING()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::RETURNSTRING ( $testValue = '' )

static

RETURNSTRING.

1.18.0

See also: Use the test() method in the TextData class instead

Parameters

mixed $testValue Value to check

Returns: null|string

Definition at line 337 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Text\test().

     {
         return TextData\Text::test($testValue);
     }

Here is the call graph for this function:

◆ RIGHT()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::RIGHT	(	$value = `''`,
		$chars = `1`
	)

static

RIGHT.

1.18.0

See also: Use the right() method in the TextData class instead

Parameters

string	$value	Value
int	$chars	Number of characters

Returns: string

Definition at line 213 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Extract\right().

     {
         return TextData\Extract::right($value, $chars);
     }

Here is the call graph for this function:

◆ SEARCHINSENSITIVE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::SEARCHINSENSITIVE	(	$needle,
		$haystack,
		$offset = `1`
	)

static

SEARCHINSENSITIVE.

1.18.0

See also: Use the insensitive() method in the TextData class instead

Parameters

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

Returns: string

Definition at line 143 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Search\insensitive().

     {
         return TextData\Search::insensitive($needle, $haystack, $offset);
     }

Here is the call graph for this function:

◆ SEARCHSENSITIVE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::SEARCHSENSITIVE	(	$needle,
		$haystack,
		$offset = `1`
	)

static

SEARCHSENSITIVE.

1.18.0

See also: Use the sensitive() method in the TextData class instead

Parameters

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

Returns: string

Definition at line 125 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Search\sensitive().

     {
         return TextData\Search::sensitive($needle, $haystack, $offset);
     }

Here is the call graph for this function:

◆ STRINGLENGTH()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::STRINGLENGTH ( $value = '' )

static

STRINGLENGTH.

1.18.0

See also: Use the length() method in the TextData class instead

Parameters

string $value Value

Returns: int

Definition at line 229 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Text\length().

     {
         return TextData\Text::length($value);
     }

Here is the call graph for this function:

◆ SUBSTITUTE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::SUBSTITUTE	(	$text = `''`,
		$fromText = `''`,
		$toText = `''`,
		$instance = `0`
	)

static

SUBSTITUTE.

1.18.0

See also: Use the substitute() method in the TextData class instead

Parameters

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

Returns: string

Definition at line 321 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\Calculation\$instance, $text, and PhpOffice\PhpSpreadsheet\Calculation\TextData\Replace\substitute().

     {
         return TextData\Replace::substitute($text, $fromText, $toText, $instance);
     }

Here is the call graph for this function:

◆ TEXTFORMAT()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::TEXTFORMAT	(	$value,
		$format
	)

static

TEXTFORMAT.

1.18.0

See also: Use the TEXTFORMAT() method in the TextData class instead

Parameters

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

Returns: string

Definition at line 354 of file TextData.php.

References $format, and PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\TEXTFORMAT().

     {
         return TextData\Format::TEXTFORMAT($value, $format);
     }

Here is the call graph for this function:

◆ TEXTJOIN()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::TEXTJOIN	(	$delimiter,
		$ignoreEmpty,
		$args
	)

static

TEXTJOIN.

1.18.0

See also: Use the TEXTJOIN() method in the TextData class instead

Parameters

mixed	$delimiter
mixed	$ignoreEmpty
mixed	$args

Returns: string

Definition at line 425 of file TextData.php.

References $delimiter, and PhpOffice\PhpSpreadsheet\Calculation\TextData\Concatenate\TEXTJOIN().

     {
         return TextData\Concatenate::TEXTJOIN($delimiter, $ignoreEmpty, ...$args);
     }

Here is the call graph for this function:

◆ TRIMNONPRINTABLE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::TRIMNONPRINTABLE ( $stringValue = '' )

static

TRIMNONPRINTABLE.

1.18.0

See also: Use the nonPrintable() method in the TextData class instead

Parameters

mixed $stringValue Value to check

Returns: string

Definition at line 39 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Trim\nonPrintable().

     {
         return TextData\Trim::nonPrintable($stringValue);
     }

Here is the call graph for this function:

◆ TRIMSPACES()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::TRIMSPACES ( $stringValue = '' )

static

TRIMSPACES.

1.18.0

See also: Use the spaces() method in the TextData class instead

Parameters

mixed $stringValue Value to check

Returns: string

Definition at line 55 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Trim\spaces().

     {
         return TextData\Trim::spaces($stringValue);
     }

Here is the call graph for this function:

◆ UPPERCASE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::UPPERCASE ( $mixedCaseString )

static

UPPERCASE.

Converts a string value to upper case.

1.18.0

See also: Use the upper() method in the TextData class instead

Parameters

string $mixedCaseString

Returns: string

Definition at line 265 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\CaseConvert\upper().

     {
         return TextData\CaseConvert::upper($mixedCaseString);
     }

Here is the call graph for this function:

◆ VALUE()

static PhpOffice\PhpSpreadsheet\Calculation\TextData::VALUE ( $value = '' )

static

VALUE.

1.18.0

See also: Use the VALUE() method in the TextData class instead

Parameters

mixed $value Value to check

Returns: DateTimeInterface|float|int|string A string if arguments are invalid

Definition at line 370 of file TextData.php.

References PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\VALUE().

     {
         return TextData\Format::VALUE($value);
     }

Here is the call graph for this function:

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Calculation/TextData.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ASCIICODE()

◆ builtinREPT()

◆ CHARACTER()

◆ CONCATENATE()

◆ DOLLAR()

◆ EXACT()

◆ FIXEDFORMAT()

◆ LEFT()

◆ LOWERCASE()

◆ MID()

◆ NUMBERVALUE()

◆ PROPERCASE()

◆ REPLACE()

◆ RETURNSTRING()

◆ RIGHT()

◆ SEARCHINSENSITIVE()

◆ SEARCHSENSITIVE()

◆ STRINGLENGTH()

◆ SUBSTITUTE()

◆ TEXTFORMAT()

◆ TEXTJOIN()

◆ TRIMNONPRINTABLE()

◆ TRIMSPACES()

◆ UPPERCASE()

◆ VALUE()