\PhpOffice\PhpSpreadsheet\Calculation\LogicalConditional

Summary

Methods
Properties
Constants
statementIf()
statementSwitch()
IFERROR()
IFNA()
IFS()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

statementIf()

statementIf(mixed  $condition = true, mixed  $returnIfTrue, mixed  $returnIfFalse = false) : mixed

STATEMENT_IF.

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

mixed $condition

Condition to evaluate

mixed $returnIfTrue

Value to return when condition is true

mixed $returnIfFalse

Optional value to return when condition is false

Returns

mixed —

The value of returnIfTrue or returnIfFalse determined by condition

statementSwitch()

statementSwitch(mixed  ...$arguments) : mixed

STATEMENT_SWITCH.

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

mixed $arguments variadic

Statement arguments

Returns

mixed —

The value of matched expression

IFERROR()

IFERROR(mixed  $testValue = '', mixed  $errorpart = '') : mixed

IFERROR.

Excel Function: =IFERROR(testValue,errorpart)

Parameters

mixed $testValue

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

mixed $errorpart

Value to return when testValue is an error condition

Returns

mixed —

The value of errorpart or testValue determined by error condition

IFNA()

IFNA(mixed  $testValue = '', mixed  $napart = '') : mixed

IFNA.

Excel Function: =IFNA(testValue,napart)

Parameters

mixed $testValue

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

mixed $napart

Value to return when testValue is an NA condition

Returns

mixed —

The value of errorpart or testValue determined by error condition

IFS()

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

IFS.

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

mixed $arguments variadic

Statement arguments

Returns

mixed|string —

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