Text Uses ArrayEnabled
Table of Contents
- $arrayArgumentHelper : ArrayArgumentHelper
- exact() : array<string|int, mixed>|bool
- Compares two text strings and returns TRUE if they are exactly the same, FALSE otherwise.
- length() : array<string|int, mixed>|int
- LEN.
- test() : null|array<string|int, mixed>|string
- RETURNSTRING.
- evaluateArrayArguments() : array<string|int, mixed>
- Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument.
- evaluateArrayArgumentsIgnore() : array<string|int, mixed>
- Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument except for the one specified by ignore.
- evaluateArrayArgumentsSubset() : array<string|int, mixed>
- Handles array argument processing when the function accepts multiple arguments, but only the first few (up to limit) can be an array arguments.
- evaluateArrayArgumentsSubsetFrom() : array<string|int, mixed>
- Handles array argument processing when the function accepts multiple arguments, but only the last few (from start) can be an array arguments.
- evaluateSingleArgumentArray() : array<string|int, mixed>
- Handles array argument processing when the function accepts a single argument that can be an array argument.
- initialiseHelper() : void
- testFalse() : bool
Properties
$arrayArgumentHelper
private
static ArrayArgumentHelper
$arrayArgumentHelper
Methods
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
-
String Value Or can be an array of values
- $value2 : mixed
-
String Value Or can be an array of values
Return values
array<string|int, mixed>|bool —If an array of values is passed for either of the arguments, then the returned result will also be an array with matching dimensions
length()
LEN.
public
static length([mixed $value = '' ]) : array<string|int, mixed>|int
Parameters
- $value : mixed = ''
-
String Value Or can be an array of values
Return values
array<string|int, mixed>|int —If an array of values is passed for the argument, then the returned result will also be an array with matching dimensions
test()
RETURNSTRING.
public
static test([mixed $testValue = '' ]) : null|array<string|int, mixed>|string
Parameters
- $testValue : mixed = ''
-
Value to check Or can be an array of values
Return values
null|array<string|int, mixed>|string —If an array of values is passed for the argument, then the returned result will also be an array with matching dimensions
evaluateArrayArguments()
Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument.
protected
static evaluateArrayArguments(callable $method, mixed ...$arguments) : array<string|int, mixed>
Example use for: ROUND() or DATE().
Parameters
- $method : callable
- $arguments : mixed
Return values
array<string|int, mixed> —evaluateArrayArgumentsIgnore()
Handles array argument processing when the function accepts multiple arguments, and any of them can be an array argument except for the one specified by ignore.
protected
static evaluateArrayArgumentsIgnore(callable $method, int $ignore, mixed ...$arguments) : array<string|int, mixed>
Example use for: HLOOKUP() and VLOOKUP(), where argument 1 is a matrix that needs to be treated as a database rather than as an array argument.
Parameters
- $method : callable
- $ignore : int
- $arguments : mixed
Return values
array<string|int, mixed> —evaluateArrayArgumentsSubset()
Handles array argument processing when the function accepts multiple arguments, but only the first few (up to limit) can be an array arguments.
protected
static evaluateArrayArgumentsSubset(callable $method, int $limit, mixed ...$arguments) : array<string|int, mixed>
Example use for: NETWORKDAYS() or CONCATENATE(), where the last argument is a matrix (or a series of values) that need to be treated as a such rather than as an array arguments.
Parameters
- $method : callable
- $limit : int
- $arguments : mixed
Return values
array<string|int, mixed> —evaluateArrayArgumentsSubsetFrom()
Handles array argument processing when the function accepts multiple arguments, but only the last few (from start) can be an array arguments.
protected
static evaluateArrayArgumentsSubsetFrom(callable $method, int $start, mixed ...$arguments) : array<string|int, mixed>
Example use for: Z.TEST() or INDEX(), where the first argument 1 is a matrix that needs to be treated as a dataset rather than as an array argument.
Parameters
- $method : callable
- $start : int
- $arguments : mixed
Return values
array<string|int, mixed> —evaluateSingleArgumentArray()
Handles array argument processing when the function accepts a single argument that can be an array argument.
protected
static evaluateSingleArgumentArray(callable $method, array<string|int, mixed> $values) : array<string|int, mixed>
Example use for: DAYOFMONTH() or FACT().
Parameters
- $method : callable
- $values : array<string|int, mixed>
Return values
array<string|int, mixed> —initialiseHelper()
private
static initialiseHelper(array<string|int, mixed>|false $arguments) : void
Parameters
- $arguments : array<string|int, mixed>|false
-
Can be changed to array for Php8.1+
Return values
void —testFalse()
private
static testFalse(mixed $value) : bool
Parameters
- $value : mixed