class PHPExcel_Calculation_Logical

PHPExcelCalculationLogical

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Methods

static boolean
TRUE()

TRUE

static boolean
FALSE()

FALSE

static boolean
LOGICAL_AND()

LOGICAL_AND

static boolean
LOGICAL_OR()

LOGICAL_OR

static boolean
NOT(mixed $logical = false)

NOT

static mixed
STATEMENT_IF(mixed $condition = true, mixed $returnIfTrue, mixed $returnIfFalse = false)

STATEMENT_IF

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

IFERROR

Details

at line 71
static boolean TRUE()

TRUE

Returns the boolean TRUE.

Excel Function: =TRUE()

Return Value

boolean True

at line 89
static boolean FALSE()

FALSE

Returns the boolean FALSE.

Excel Function: =FALSE()

Return Value

boolean False

at line 116
static boolean LOGICAL_AND()

LOGICAL_AND

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

Return Value

boolean The logical AND of the arguments.

at line 172
static boolean LOGICAL_OR()

LOGICAL_OR

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

Return Value

boolean The logical OR of the arguments.

at line 227
static boolean NOT(mixed $logical = false)

NOT

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

mixed $logical A value or expression that can be evaluated to TRUE or FALSE

Return Value

boolean The boolean inverse of the argument.

at line 276
static mixed STATEMENT_IF(mixed $condition = true, mixed $returnIfTrue, mixed $returnIfFalse = false)

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

Return Value

mixed The value of returnIfTrue or returnIfFalse determined by condition

at line 298
static mixed IFERROR(mixed $testValue = '', mixed $errorpart = '')

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

Return Value

mixed The value of errorpart or testValue determined by error condition