Documentation

Concatenate
in package
uses ArrayEnabled

Table of Contents

Properties

$arrayArgumentHelper  : ArrayArgumentHelper
$initializationNeeded  : bool

Methods

actualCONCATENATE()  : array<string|int, mixed>|string
This implements the CONCATENATE function.
builtinREPT()  : array<string|int, mixed>|string
REPT.
CONCATENATE()  : string
This implements the CONCAT function, *not* CONCATENATE.
TEXTJOIN()  : array<string|int, mixed>|string
TEXTJOIN.
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.
concatenate2Args()  : array<string|int, mixed>|string
evaluateTextJoinArray()  : string|null
initialiseHelper()  : void
testFalse()  : bool

Properties

$initializationNeeded

private static bool $initializationNeeded = true

Methods

actualCONCATENATE()

This implements the CONCATENATE function.

public static actualCONCATENATE(array<string|int, mixed> ...$args) : array<string|int, mixed>|string
Parameters
$args : array<string|int, mixed>

data to be concatenated

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

builtinREPT()

REPT.

public static builtinREPT(mixed $stringValue, mixed $repeatCount) : array<string|int, mixed>|string

Returns the result of builtin function round after validating args.

Parameters
$stringValue : mixed

The value to repeat Or can be an array of values

$repeatCount : mixed

The number of times the string value should be repeated Or can be an array of values

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

The repeated string If an array of values is passed for the $stringValue or $repeatCount arguments, then the returned result will also be an array with matching dimensions

CONCATENATE()

This implements the CONCAT function, *not* CONCATENATE.

public static CONCATENATE(array<string|int, mixed> ...$args) : string
Parameters
$args : array<string|int, mixed>
Return values
string

TEXTJOIN()

TEXTJOIN.

public static TEXTJOIN([mixed $delimiter = '' ][, mixed $ignoreEmpty = true ], mixed ...$args) : array<string|int, mixed>|string
Parameters
$delimiter : mixed = ''

The delimter to use between the joined arguments Or can be an array of values

$ignoreEmpty : mixed = true

true/false Flag indicating whether empty arguments should be skipped Or can be an array of values

$args : mixed

The values to join

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

The joined string If an array of values is passed for the $delimiter or $ignoreEmpty arguments, 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>

concatenate2Args()

private static concatenate2Args(array<string|int, mixed>|string $operand1, null|array<string|int, mixed>|bool|float|int|string $operand2) : array<string|int, mixed>|string
Parameters
$operand1 : array<string|int, mixed>|string
$operand2 : null|array<string|int, mixed>|bool|float|int|string
Return values
array<string|int, mixed>|string

evaluateTextJoinArray()

private static evaluateTextJoinArray(bool $ignoreEmpty, array<string|int, mixed> &$aArgs) : string|null
Parameters
$ignoreEmpty : bool
$aArgs : array<string|int, mixed>
Return values
string|null

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+

testFalse()

private static testFalse(mixed $value) : bool
Parameters
$value : mixed
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results