Documentation

TextData

Tags
deprecated
1.18.0

Table of Contents

ASCIICODE()  : array<string|int, mixed>|int|string
ASCIICODE.
builtinREPT()  : array<string|int, mixed>|string
REPT.
CHARACTER()  : array<string|int, mixed>|string
CHARACTER.
CONCATENATE()  : string
CONCATENATE.
DOLLAR()  : array<string|int, mixed>|string
DOLLAR.
EXACT()  : array<string|int, mixed>|bool
Compares two text strings and returns TRUE if they are exactly the same, FALSE otherwise.
FIXEDFORMAT()  : array<string|int, mixed>|string
FIXEDFORMAT.
LEFT()  : array<string|int, mixed>|string
LEFT.
LOWERCASE()  : array<string|int, mixed>|string
LOWERCASE.
MID()  : array<string|int, mixed>|string
MID.
NUMBERVALUE()  : array<string|int, mixed>|float|string
NUMBERVALUE.
PROPERCASE()  : array<string|int, mixed>|string
PROPERCASE.
REPLACE()  : array<string|int, mixed>|string
REPLACE.
RETURNSTRING()  : null|array<string|int, mixed>|string
RETURNSTRING.
RIGHT()  : array<string|int, mixed>|string
RIGHT.
SEARCHINSENSITIVE()  : array<string|int, mixed>|int|string
SEARCH.
SEARCHSENSITIVE()  : array<string|int, mixed>|int|string
FIND.
STRINGLENGTH()  : array<string|int, mixed>|int
STRINGLENGTH.
SUBSTITUTE()  : array<string|int, mixed>|string
SUBSTITUTE.
TEXTFORMAT()  : array<string|int, mixed>|string
TEXTFORMAT.
TEXTJOIN()  : array<string|int, mixed>|string
TEXTJOIN.
TRIMNONPRINTABLE()  : null|array<string|int, mixed>|string
TRIMNONPRINTABLE.
TRIMSPACES()  : array<string|int, mixed>|string
TRIMSPACES.
UPPERCASE()  : array<string|int, mixed>|string
UPPERCASE.
VALUE()  : array<string|int, mixed>|DateTimeInterface|float|int|string
VALUE.

Methods

ASCIICODE()

ASCIICODE.

public static ASCIICODE(array<string|int, mixed>|string $characters) : array<string|int, mixed>|int|string
Parameters
$characters : array<string|int, mixed>|string

Value

Tags
Deprecated

1.18.0

see
Use

the code() method in the TextData\CharacterConvert class instead

Return values
array<string|int, mixed>|int|string —

A string if arguments are invalid

builtinREPT()

REPT.

public static builtinREPT(array<string|int, mixed>|string $str, mixed $number) : array<string|int, mixed>|string

Returns the result of builtin function repeat after validating args.

Parameters
$str : array<string|int, mixed>|string

Should be numeric

$number : mixed

Should be int

Tags
Deprecated

1.18.0

see
Use

the builtinREPT() method in the TextData\Concatenate class instead

Return values
array<string|int, mixed>|string —

CHARACTER()

CHARACTER.

public static CHARACTER(string $character) : array<string|int, mixed>|string
Parameters
$character : string

Value

Tags
Deprecated

1.18.0

see
Use

the character() method in the TextData\CharacterConvert class instead

Return values
array<string|int, mixed>|string —

CONCATENATE()

CONCATENATE.

public static CONCATENATE(mixed ...$args) : string
Parameters
$args : mixed
Tags
Deprecated

1.18.0

see
Use

the CONCATENATE() method in the TextData\Concatenate class instead

Return values
string —

DOLLAR()

DOLLAR.

public static DOLLAR(float $value[, int $decimals = 2 ]) : array<string|int, mixed>|string

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
$value : float

The value to format

$decimals : int = 2

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

Tags
Deprecated

1.18.0

see
Use

the DOLLAR() method in the TextData\Format class instead

Return values
array<string|int, mixed>|string —

EXACT()

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

public static EXACT(mixed $value1, mixed $value2) : array<string|int, mixed>|bool

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

Parameters
$value1 : mixed
$value2 : mixed
Tags
Deprecated

1.18.0

see
Use

the exact() method in the TextData\Text class instead

Return values
array<string|int, mixed>|bool —

FIXEDFORMAT()

FIXEDFORMAT.

public static FIXEDFORMAT(mixed $value[, int $decimals = 2 ][, bool $no_commas = false ]) : array<string|int, mixed>|string
Parameters
$value : mixed

Value to check

$decimals : int = 2
$no_commas : bool = false
Tags
Deprecated

1.18.0

see
Use

the FIXEDFORMAT() method in the TextData\Format class instead

Return values
array<string|int, mixed>|string —

LEFT()

LEFT.

public static LEFT([array<string|int, mixed>|string $value = '' ][, array<string|int, mixed>|int $chars = 1 ]) : array<string|int, mixed>|string
Parameters
$value : array<string|int, mixed>|string = ''

Value

$chars : array<string|int, mixed>|int = 1

Number of characters

Tags
Deprecated

1.18.0

see
Use

the left() method in the TextData\Extract class instead

Return values
array<string|int, mixed>|string —

LOWERCASE()

LOWERCASE.

public static LOWERCASE(array<string|int, mixed>|string $mixedCaseString) : array<string|int, mixed>|string

Converts a string value to lower case.

Parameters
$mixedCaseString : array<string|int, mixed>|string
Tags
Deprecated

1.18.0

see
Use

the lower() method in the TextData\CaseConvert class instead

Return values
array<string|int, mixed>|string —

MID()

MID.

public static MID([array<string|int, mixed>|string $value = '' ][, array<string|int, mixed>|int $start = 1 ][, array<string|int, mixed>|int $chars = null ]) : array<string|int, mixed>|string
Parameters
$value : array<string|int, mixed>|string = ''

Value

$start : array<string|int, mixed>|int = 1

Start character

$chars : array<string|int, mixed>|int = null

Number of characters

Tags
Deprecated

1.18.0

see
Use

the mid() method in the TextData\Extract class instead

Return values
array<string|int, mixed>|string —

NUMBERVALUE()

NUMBERVALUE.

public static NUMBERVALUE([mixed $value = '' ][, string $decimalSeparator = null ][, string $groupSeparator = null ]) : array<string|int, mixed>|float|string
Parameters
$value : mixed = ''

Value to check

$decimalSeparator : string = null

decimal separator, defaults to locale defined value

$groupSeparator : string = null

group/thosands separator, defaults to locale defined value

Tags
Deprecated

1.18.0

see
Use

the NUMBERVALUE() method in the TextData\Format class instead

Return values
array<string|int, mixed>|float|string —

PROPERCASE()

PROPERCASE.

public static PROPERCASE(array<string|int, mixed>|string $mixedCaseString) : array<string|int, mixed>|string

Converts a string value to proper/title case.

Parameters
$mixedCaseString : array<string|int, mixed>|string
Tags
Deprecated

1.18.0

see
Use

the proper() method in the TextData\CaseConvert class instead

Return values
array<string|int, mixed>|string —

REPLACE()

REPLACE.

public static REPLACE(string $oldText, int $start, int $chars, string $newText) : array<string|int, mixed>|string
Parameters
$oldText : string

String to modify

$start : int

Start character

$chars : int

Number of characters

$newText : string

String to replace in defined position

Tags
Deprecated

1.18.0

see
Use

the replace() method in the TextData\Replace class instead

Return values
array<string|int, mixed>|string —

RETURNSTRING()

RETURNSTRING.

public static RETURNSTRING([mixed $testValue = '' ]) : null|array<string|int, mixed>|string
Parameters
$testValue : mixed = ''

Value to check

Tags
Deprecated

1.18.0

see
Use

the test() method in the TextData\Text class instead

Return values
null|array<string|int, mixed>|string —

RIGHT()

RIGHT.

public static RIGHT([array<string|int, mixed>|string $value = '' ][, array<string|int, mixed>|int $chars = 1 ]) : array<string|int, mixed>|string
Parameters
$value : array<string|int, mixed>|string = ''

Value

$chars : array<string|int, mixed>|int = 1

Number of characters

Tags
Deprecated

1.18.0

see
Use

the right() method in the TextData\Extract class instead

Return values
array<string|int, mixed>|string —

SEARCHINSENSITIVE()

SEARCH.

public static SEARCHINSENSITIVE(array<string|int, mixed>|string $needle, array<string|int, mixed>|string $haystack[, array<string|int, mixed>|int $offset = 1 ]) : array<string|int, mixed>|int|string
Parameters
$needle : array<string|int, mixed>|string

The string to look for

$haystack : array<string|int, mixed>|string

The string in which to look

$offset : array<string|int, mixed>|int = 1

Offset within $haystack

Tags
Deprecated

1.18.0

see
Use

the insensitive() method in the TextData\Search class instead

Return values
array<string|int, mixed>|int|string —

SEARCHSENSITIVE()

FIND.

public static SEARCHSENSITIVE(array<string|int, mixed>|string $needle, array<string|int, mixed>|string $haystack[, array<string|int, mixed>|int $offset = 1 ]) : array<string|int, mixed>|int|string
Parameters
$needle : array<string|int, mixed>|string

The string to look for

$haystack : array<string|int, mixed>|string

The string in which to look

$offset : array<string|int, mixed>|int = 1

Offset within $haystack

Tags
Deprecated

1.18.0

see
Use

the sensitive() method in the TextData\Search class instead

Return values
array<string|int, mixed>|int|string —

STRINGLENGTH()

STRINGLENGTH.

public static STRINGLENGTH([string $value = '' ]) : array<string|int, mixed>|int
Parameters
$value : string = ''

Value

Tags
Deprecated

1.18.0

see
Use

the length() method in the TextData\Text class instead

Return values
array<string|int, mixed>|int —

SUBSTITUTE()

SUBSTITUTE.

public static SUBSTITUTE([string $text = '' ][, string $fromText = '' ][, string $toText = '' ], int $instance) : array<string|int, mixed>|string
Parameters
$text : string = ''

Value

$fromText : string = ''

From Value

$toText : string = ''

To Value

$instance : int

Instance Number

Tags
Deprecated

1.18.0

see
Use

the substitute() method in the TextData\Replace class instead

Return values
array<string|int, mixed>|string —

TEXTFORMAT()

TEXTFORMAT.

public static TEXTFORMAT(mixed $value, string $format) : array<string|int, mixed>|string
Parameters
$value : mixed

Value to check

$format : string

Format mask to use

Tags
Deprecated

1.18.0

see
Use

the TEXTFORMAT() method in the TextData\Format class instead

Return values
array<string|int, mixed>|string —

TEXTJOIN()

TEXTJOIN.

public static TEXTJOIN(mixed $delimiter, mixed $ignoreEmpty, mixed ...$args) : array<string|int, mixed>|string
Parameters
$delimiter : mixed
$ignoreEmpty : mixed
$args : mixed
Tags
Deprecated

1.18.0

see
Use

the TEXTJOIN() method in the TextData\Concatenate class instead

Return values
array<string|int, mixed>|string —

TRIMNONPRINTABLE()

TRIMNONPRINTABLE.

public static TRIMNONPRINTABLE([mixed $stringValue = '' ]) : null|array<string|int, mixed>|string
Parameters
$stringValue : mixed = ''

Value to check

Tags
Deprecated

1.18.0

see
Use

the nonPrintable() method in the TextData\Trim class instead

Return values
null|array<string|int, mixed>|string —

TRIMSPACES()

TRIMSPACES.

public static TRIMSPACES([mixed $stringValue = '' ]) : array<string|int, mixed>|string
Parameters
$stringValue : mixed = ''

Value to check

Tags
Deprecated

1.18.0

see
Use

the spaces() method in the TextData\Trim class instead

Return values
array<string|int, mixed>|string —

UPPERCASE()

UPPERCASE.

public static UPPERCASE(string $mixedCaseString) : array<string|int, mixed>|string

Converts a string value to upper case.

Parameters
$mixedCaseString : string
Tags
Deprecated

1.18.0

see
Use

the upper() method in the TextData\CaseConvert class instead

Return values
array<string|int, mixed>|string —

VALUE()

VALUE.

public static VALUE([mixed $value = '' ]) : array<string|int, mixed>|DateTimeInterface|float|int|string
Parameters
$value : mixed = ''

Value to check

Tags
Deprecated

1.18.0

see
Use

the VALUE() method in the TextData\Format class instead

Return values
array<string|int, mixed>|DateTimeInterface|float|int|string —

A string if arguments are invalid

Search results