Documentation

Logical

Tags
deprecated
1.17.0

Table of Contents

false()  : bool
FALSE.
IFERROR()  : mixed
IFERROR.
IFNA()  : mixed
IFNA.
IFS()  : mixed|string
IFS.
logicalAnd()  : bool|string
LOGICAL_AND.
logicalOr()  : bool|string
LOGICAL_OR.
logicalXor()  : bool|string
LOGICAL_XOR.
NOT()  : array<string|int, mixed>|bool|string
NOT.
statementIf()  : mixed
STATEMENT_IF.
statementSwitch()  : mixed
STATEMENT_SWITCH.
true()  : bool
TRUE.

Methods

false()

FALSE.

public static false() : bool

Returns the boolean FALSE.

Excel Function: =FALSE()

Tags
Deprecated

1.17.0

see
Boolean::FALSE()

Use the FALSE() method in the Logical\Boolean class instead

Return values
bool

False

IFERROR()

IFERROR.

public static IFERROR([mixed $testValue = '' ][, mixed $errorpart = '' ]) : mixed

Excel Function: =IFERROR(testValue,errorpart)

Parameters
$testValue : mixed = ''

Value to check, is also the value returned when no error

$errorpart : mixed = ''

Value to return when testValue is an error condition

Tags
Deprecated

1.17.0

see
Conditional::IFERROR()

Use the IFERROR() method in the Logical\Conditional class instead

Return values
mixed

The value of errorpart or testValue determined by error condition

IFNA()

IFNA.

public static IFNA([mixed $testValue = '' ][, mixed $napart = '' ]) : mixed

Excel Function: =IFNA(testValue,napart)

Parameters
$testValue : mixed = ''

Value to check, is also the value returned when not an NA

$napart : mixed = ''

Value to return when testValue is an NA condition

Tags
Deprecated

1.17.0

see
Conditional::IFNA()

Use the IFNA() method in the Logical\Conditional class instead

Return values
mixed

The value of errorpart or testValue determined by error condition

IFS()

IFS.

public static IFS(mixed ...$arguments) : mixed|string

Excel Function: =IFS(testValue1;returnIfTrue1;testValue2;returnIfTrue2;...;testValue_n;returnIfTrue_n)

testValue1 ... testValue_n Conditions to Evaluate returnIfTrue1 ... returnIfTrue_n Value returned if corresponding testValue (nth) was true

Parameters
$arguments : mixed

Statement arguments

Tags
Deprecated

1.17.0

see
Conditional::IFS()

Use the IFS() method in the Logical\Conditional class instead

Return values
mixed|string

The value of returnIfTrue_n, if testValue_n was true. #N/A if none of testValues was true

logicalAnd()

LOGICAL_AND.

public static logicalAnd(mixed ...$args) : bool|string

Returns boolean TRUE if all its arguments are TRUE; returns FALSE if one or more argument is FALSE.

Excel Function: =AND(logical1[,logical2[, ...]])

   The arguments must evaluate to logical values such as TRUE or FALSE, or the arguments must be arrays
       or references that contain logical values.

   Boolean arguments are treated as True or False as appropriate
   Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False
   If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string
       holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
Parameters
$args : mixed

Data values

Tags
Deprecated

1.17.0

see
Operations::logicalAnd()

Use the logicalAnd() method in the Logical\Operations class instead

Return values
bool|string

the logical AND of the arguments

logicalOr()

LOGICAL_OR.

public static logicalOr(mixed ...$args) : bool|string

Returns boolean TRUE if any argument is TRUE; returns FALSE if all arguments are FALSE.

Excel Function: =OR(logical1[,logical2[, ...]])

   The arguments must evaluate to logical values such as TRUE or FALSE, or the arguments must be arrays
       or references that contain logical values.

   Boolean arguments are treated as True or False as appropriate
   Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False
   If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string
       holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
Parameters
$args : mixed

Data values

Tags
Deprecated

1.17.0

see
Operations::logicalOr()

Use the logicalOr() method in the Logical\Operations class instead

Return values
bool|string

the logical OR of the arguments

logicalXor()

LOGICAL_XOR.

public static logicalXor(mixed ...$args) : bool|string

Returns the Exclusive Or logical operation for one or more supplied conditions. i.e. the Xor function returns TRUE if an odd number of the supplied conditions evaluate to TRUE, and FALSE otherwise.

Excel Function: =XOR(logical1[,logical2[, ...]])

   The arguments must evaluate to logical values such as TRUE or FALSE, or the arguments must be arrays
       or references that contain logical values.

   Boolean arguments are treated as True or False as appropriate
   Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False
   If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string
       holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
Parameters
$args : mixed

Data values

Tags
Deprecated

1.17.0

see
Operations::logicalXor()

Use the logicalXor() method in the Logical\Operations class instead

Return values
bool|string

the logical XOR of the arguments

NOT()

NOT.

public static NOT([mixed $logical = false ]) : array<string|int, mixed>|bool|string

Returns the boolean inverse of the argument.

Excel Function: =NOT(logical)

   The argument must evaluate to a logical value such as TRUE or FALSE

   Boolean arguments are treated as True or False as appropriate
   Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False
   If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string
       holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
Parameters
$logical : mixed = false

A value or expression that can be evaluated to TRUE or FALSE

Tags
Deprecated

1.17.0

see
Operations::NOT()

Use the NOT() method in the Logical\Operations class instead

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

the boolean inverse of the argument

statementIf()

STATEMENT_IF.

public static statementIf([mixed $condition = true ], mixed $returnIfTrue[, mixed $returnIfFalse = false ]) : mixed

Returns one value if a condition you specify evaluates to TRUE and another value if it evaluates to FALSE.

Excel Function: =IF(condition[,returnIfTrue[,returnIfFalse]])

   Condition is any value or expression that can be evaluated to TRUE or FALSE.
       For example, A10=100 is a logical expression; if the value in cell A10 is equal to 100,
       the expression evaluates to TRUE. Otherwise, the expression evaluates to FALSE.
       This argument can use any comparison calculation operator.
   ReturnIfTrue is the value that is returned if condition evaluates to TRUE.
       For example, if this argument is the text string "Within budget" and the condition argument
           evaluates to TRUE, then the IF function returns the text "Within budget"
       If condition is TRUE and ReturnIfTrue is blank, this argument returns 0 (zero).
          To display the word TRUE, use the logical value TRUE for this argument.
       ReturnIfTrue can be another formula.
   ReturnIfFalse is the value that is returned if condition evaluates to FALSE.
       For example, if this argument is the text string "Over budget" and the condition argument
           evaluates to FALSE, then the IF function returns the text "Over budget".
       If condition is FALSE and ReturnIfFalse is omitted, then the logical value FALSE is returned.
       If condition is FALSE and ReturnIfFalse is blank, then the value 0 (zero) is returned.
       ReturnIfFalse can be another formula.
Parameters
$condition : mixed = true

Condition to evaluate

$returnIfTrue : mixed

Value to return when condition is true

$returnIfFalse : mixed = false

Optional value to return when condition is false

Tags
Deprecated

1.17.0

see
Conditional::statementIf()

Use the statementIf() method in the Logical\Conditional class instead

Return values
mixed

The value of returnIfTrue or returnIfFalse determined by condition

statementSwitch()

STATEMENT_SWITCH.

public static statementSwitch(mixed ...$arguments) : mixed

Returns corresponding with first match (any data type such as a string, numeric, date, etc).

Excel Function: =SWITCH (expression, value1, result1, value2, result2, ... value_n, result_n [, default])

   Expression
         The expression to compare to a list of values.
   value1, value2, ... value_n
         A list of values that are compared to expression.
         The SWITCH function is looking for the first value that matches the expression.
   result1, result2, ... result_n
         A list of results. The SWITCH function returns the corresponding result when a value
         matches expression.
    default
         Optional. It is the default to return if expression does not match any of the values
         (value1, value2, ... value_n).
Parameters
$arguments : mixed

Statement arguments

Tags
Deprecated

1.17.0

see
Conditional::statementSwitch()

Use the statementSwitch() method in the Logical\Conditional class instead

Return values
mixed

The value of matched expression

true()

TRUE.

public static true() : bool

Returns the boolean TRUE.

Excel Function: =TRUE()

Tags
Deprecated

1.17.0

see
Boolean::TRUE()

Use the TRUE() method in the Logical\Boolean class instead

Return values
bool

True

Search results