Documentation

Lookup
in package
Uses ArrayEnabled

Table of Contents

Properties

$arrayArgumentHelper  : ArrayArgumentHelper|null

Methods

lookup()  : mixed
LOOKUP The LOOKUP function searches for value either from a one-row or one-column range or from an array.
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.
columnCount()  : int
initialiseHelper()  : void
rowCount()  : int
testFalse()  : bool
verifyLookupValues()  : array<string|int, mixed>
verifyResultVector()  : array<string|int, mixed>

Properties

Methods

lookup()

LOOKUP The LOOKUP function searches for value either from a one-row or one-column range or from an array.

public static lookup(mixed $lookupValue, mixed $lookupVector[, null|mixed $resultVector = null ]) : mixed
Parameters
$lookupValue : mixed

The value that you want to match in lookup_array

$lookupVector : mixed

The range of cells being searched

$resultVector : null|mixed = null

The column from which the matching value must be returned

Return values
mixed —

The value of the found cell

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>

columnCount()

private static columnCount(array<string|int, mixed> $dataArray) : int
Parameters
$dataArray : array<string|int, mixed>
Return values
int

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+

rowCount()

private static rowCount(array<string|int, mixed> $dataArray) : int
Parameters
$dataArray : array<string|int, mixed>
Return values
int

testFalse()

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

verifyLookupValues()

private static verifyLookupValues(array<string|int, mixed> $lookupVector, array<string|int, mixed> $resultVector) : array<string|int, mixed>
Parameters
$lookupVector : array<string|int, mixed>
$resultVector : array<string|int, mixed>
Return values
array<string|int, mixed>

verifyResultVector()

private static verifyResultVector(array<string|int, mixed> $resultVector) : array<string|int, mixed>
Parameters
$resultVector : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results