Documentation

Value
in package
uses ArrayEnabled

Table of Contents

Properties

$arrayArgumentHelper  : ArrayArgumentHelper
$initializationNeeded  : bool

Methods

asNumber()  : number|string
N.
isBlank()  : array<string|int, mixed>|bool
IS_BLANK.
isEven()  : array<string|int, mixed>|bool|string
IS_EVEN.
isFormula()  : array<string|int, mixed>|bool|string
ISFORMULA.
isLogical()  : array<string|int, mixed>|bool
IS_LOGICAL.
isNonText()  : array<string|int, mixed>|bool
IS_NONTEXT.
isNumber()  : array<string|int, mixed>|bool
IS_NUMBER.
isOdd()  : array<string|int, mixed>|bool|string
IS_ODD.
isRef()  : bool
IS_REF.
isText()  : array<string|int, mixed>|bool
IS_TEXT.
type()  : int
TYPE.
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

$initializationNeeded

private static bool $initializationNeeded = true

Methods

asNumber()

N.

public static asNumber([null|mixed $value = null ]) : number|string

Returns a value converted to a number

Parameters
$value : null|mixed = null

The value you want converted

Return values
number|string —

N converts values listed in the following table If value is or refers to N returns A number That number value A date The Excel serialized number of that date TRUE 1 FALSE 0 An error value The error value Anything else 0

isBlank()

IS_BLANK.

public static isBlank([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

isEven()

IS_EVEN.

public static isEven([mixed $value = null ]) : array<string|int, mixed>|bool|string
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

isFormula()

ISFORMULA.

public static isFormula([mixed $cellReference = '' ][, Cell|null $cell = null ]) : array<string|int, mixed>|bool|string
Parameters
$cellReference : mixed = ''

The cell to check

$cell : Cell|null = null

The current cell (containing this formula)

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

isLogical()

IS_LOGICAL.

public static isLogical([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

isNonText()

IS_NONTEXT.

public static isNonText([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

isNumber()

IS_NUMBER.

public static isNumber([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

isOdd()

IS_ODD.

public static isOdd([mixed $value = null ]) : array<string|int, mixed>|bool|string
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

isRef()

IS_REF.

public static isRef(mixed $value[, Cell|null $cell = null ]) : bool
Parameters
$value : mixed

Value to check

$cell : Cell|null = null
Return values
bool

isText()

IS_TEXT.

public static isText([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check Or can be an array of values

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

If an array of numbers is passed as an argument, then the returned result will also be an array with the same dimensions

type()

TYPE.

public static type([null|mixed $value = null ]) : int

Returns a number that identifies the type of a value

Parameters
$value : null|mixed = null

The value you want tested

Return values
int —

N converts values listed in the following table If value is or refers to N returns A number 1 Text 2 Logical Value 4 An error value 16 Array or Matrix 64

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+

testFalse()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results