Collaboration diagram for PHPExcel_Calculation_Functions:

Static Public Member Functions
static	setCompatibilityMode ($compatibilityMode)
static	getCompatibilityMode ()
static	setReturnDateType ($returnDateType)
static	getReturnDateType ()
static	DUMMY ()
static	DIV0 ()
static	NA ()
static	NaN ()
static	NAME ()
static	REF ()
static	NULL ()
static	VALUE ()
static	isMatrixValue ($idx)
static	isValue ($idx)
static	isCellValue ($idx)
static	_ifCondition ($condition)
static	ERROR_TYPE ($value= '')
	ERROR_TYPE.
static	IS_BLANK ($value=null)
	IS_BLANK.
static	IS_ERR ($value= '')
	IS_ERR.
static	IS_ERROR ($value= '')
	IS_ERROR.
static	IS_NA ($value= '')
	IS_NA.
static	IS_EVEN ($value=0)
	IS_EVEN.
static	IS_ODD ($value=null)
	IS_ODD.
static	IS_NUMBER ($value=0)
	IS_NUMBER.
static	IS_LOGICAL ($value=true)
	IS_LOGICAL.
static	IS_TEXT ($value= '')
	IS_TEXT.
static	IS_NONTEXT ($value= '')
	IS_NONTEXT.
static	VERSION ()
	VERSION.
static	N ($value)
	N.
static	TYPE ($value)
	TYPE.
static	flattenArray ($array)
	Convert a multi-dimensional array to a simple 1-dimensional array.
static	flattenArrayIndexed ($array)
	Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.
static	flattenSingleValue ($value= '')
	Convert an array to a single scalar value by extracting the first element.

Data Fields
const	COMPATIBILITY_EXCEL = 'Excel'
	constants
const	COMPATIBILITY_GNUMERIC = 'Gnumeric'
const	COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc'
const	RETURNDATE_PHP_NUMERIC = 'P'
const	RETURNDATE_PHP_OBJECT = 'O'
const	RETURNDATE_EXCEL = 'E'

Static Protected Attributes
static	$compatibilityMode = self::COMPATIBILITY_EXCEL
static	$ReturnDateType = self::RETURNDATE_EXCEL
static	$_errorCodes

Detailed Description

Definition at line 59 of file Functions.php.

Member Function Documentation

static PHPExcel_Calculation_Functions::_ifCondition ( $condition )

static

Definition at line 309 of file Functions.php.

References PHPExcel_Calculation\_wrapResult(), and flattenSingleValue().

Referenced by PHPExcel_Calculation_Database\__filter(), PHPExcel_Calculation_Statistical\AVERAGEIF(), PHPExcel_Calculation_Statistical\COUNTIF(), PHPExcel_Calculation_Statistical\MAXIF(), PHPExcel_Calculation_Statistical\MINIF(), and PHPExcel_Calculation_MathTrig\SUMIF().

                                                        {
                $condition      = PHPExcel_Calculation_Functions::flattenSingleValue($condition);
                if (!in_array($condition{0},array('>', '<', '='))) {
                        if (!is_numeric($condition)) { $condition = PHPExcel_Calculation::_wrapResult(strtoupper($condition)); }
                        return '='.$condition;
                } else {
                        preg_match('/([<>=]+)(.*)/',$condition,$matches);
                        list(,$operator,$operand) = $matches;
                        if (!is_numeric($operand)) { $operand = PHPExcel_Calculation::_wrapResult(strtoupper($operand)); }
                        return $operator.$operand;
                }
        }       //      function _ifCondition()

Here is the call graph for this function:

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::DIV0 ( )

static

Definition at line 201 of file Functions.php.

                                      {
                return self::$_errorCodes['divisionbyzero'];
        }       //      function DIV0()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::DUMMY ( )

static

Definition at line 189 of file Functions.php.

                                       {
                return '#Not Yet Implemented';
        }       //      function DUMMY()

static PHPExcel_Calculation_Functions::ERROR_TYPE ( $value = '' )

static

ERROR_TYPE.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 329 of file Functions.php.

References flattenSingleValue().

                                                       {
                $value  = self::flattenSingleValue($value);
                $i = 1;
                foreach(self::$_errorCodes as $errorCode) {
                        if ($value == $errorCode) {
                                return $i;
                        }
                        ++$i;
                }
                return self::$_errorCodes['na'];
        }       //      function ERROR_TYPE()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::flattenArray ( $array )

static

Convert a multi-dimensional array to a simple 1-dimensional array.

Parameters

array $array Array to be flattened

Returns: array Flattened array

Definition at line 588 of file Functions.php.

                                                    {
                if (!is_array($array)) {
                        return (array) $array;
                }
                $arrayValues = array();
                foreach ($array as $value) {
                        if (is_array($value)) {
                                foreach ($value as $val) {
                                        if (is_array($val)) {
                                                foreach ($val as $v) {
                                                        $arrayValues[] = $v;
                                                }
                                        } else {
                                                $arrayValues[] = $val;
                                        }
                                }
                        } else {
                                $arrayValues[] = $value;
                        }
                }
                return $arrayValues;
        }       //      function flattenArray()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::flattenArrayIndexed ( $array )

static

Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.

Parameters

array $array Array to be flattened

Returns: array Flattened array

Definition at line 620 of file Functions.php.

                                                           {
                if (!is_array($array)) {
                        return (array) $array;
                }
                $arrayValues = array();
                foreach ($array as $k1 => $value) {
                        if (is_array($value)) {
                                foreach ($value as $k2 => $val) {
                                        if (is_array($val)) {
                                                foreach ($val as $k3 => $v) {
                                                        $arrayValues[$k1.'.'.$k2.'.'.$k3] = $v;
                                                }
                                        } else {
                                                $arrayValues[$k1.'.'.$k2] = $val;
                                        }
                                }
                        } else {
                                $arrayValues[$k1] = $value;
                        }
                }
                return $arrayValues;
        }       //      function flattenArrayIndexed()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::flattenSingleValue ( $value = '' )

static

Convert an array to a single scalar value by extracting the first element.

Parameters

mixed $value Array or scalar value

Returns: mixed

Definition at line 652 of file Functions.php.

                                                               {
                while (is_array($value)) {
                        $value = array_pop($value);
                }
                return $value;
        }       //      function flattenSingleValue()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::getCompatibilityMode ( )

static

Definition at line 138 of file Functions.php.

References $compatibilityMode.

                                                      {
                return self::$compatibilityMode;
        }       //      function getCompatibilityMode()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::getReturnDateType ( )

static

Definition at line 177 of file Functions.php.

References $ReturnDateType.

                                                   {
                return self::$ReturnDateType;
        }       //      function getReturnDateType()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::IS_BLANK ( $value = null )

static

IS_BLANK.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 349 of file Functions.php.

References flattenSingleValue().

                                                     {
                if (!is_null($value)) {
                        $value  = self::flattenSingleValue($value);
                }
                return is_null($value);
        }       //      function IS_BLANK()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_ERR ( $value = '' )

static

IS_ERR.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 364 of file Functions.php.

References flattenSingleValue(), IS_ERROR(), and IS_NA().

                                                   {
                $value          = self::flattenSingleValue($value);
                return self::IS_ERROR($value) && (!self::IS_NA($value));
        }       //      function IS_ERR()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_ERROR ( $value = '' )

static

IS_ERROR.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 377 of file Functions.php.

References flattenSingleValue().

Referenced by PHPExcel_Calculation_Logical\IFERROR(), and IS_ERR().

                                                     {
                $value          = self::flattenSingleValue($value);
                return in_array($value, array_values(self::$_errorCodes));
        }       //      function IS_ERROR()

Here is the call graph for this function:

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::IS_EVEN ( $value = 0 )

static

IS_EVEN.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 403 of file Functions.php.

References flattenSingleValue().

                                                   {
                $value          = self::flattenSingleValue($value);
                if ((is_bool($value)) || ((is_string($value)) && (!is_numeric($value)))) {
                        return self::$_errorCodes['value'];
                }
                return ($value % 2 == 0);
        }       //      function IS_EVEN()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_LOGICAL ( $value = true )

static

IS_LOGICAL.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 451 of file Functions.php.

References flattenSingleValue().

                                                         {
                $value          = self::flattenSingleValue($value);
                return is_bool($value);
        }       //      function IS_LOGICAL()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_NA ( $value = '' )

static

IS_NA.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 390 of file Functions.php.

References flattenSingleValue().

Referenced by IS_ERR().

                                                  {
                $value          = self::flattenSingleValue($value);
                return ($value === self::$_errorCodes['na']);
        }       //      function IS_NA()

Here is the call graph for this function:

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::IS_NONTEXT ( $value = '' )

static

IS_NONTEXT.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 477 of file Functions.php.

References IS_TEXT().

                                                       {
                return !self::IS_TEXT($value);
        }       //      function IS_NONTEXT()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_NUMBER ( $value = 0 )

static

IS_NUMBER.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 435 of file Functions.php.

References flattenSingleValue().

                                                     {
                $value          = self::flattenSingleValue($value);
                if (is_string($value)) {
                        return False;
                }
                return is_numeric($value);
        }       //      function IS_NUMBER()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_ODD ( $value = null )

static

IS_ODD.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 419 of file Functions.php.

References flattenSingleValue().

                                                     {
                $value  = self::flattenSingleValue($value);
                if ((is_bool($value)) || ((is_string($value)) && (!is_numeric($value)))) {
                        return self::$_errorCodes['value'];
                }
                return (abs($value) % 2 == 1);
        }       //      function IS_ODD()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::IS_TEXT ( $value = '' )

static

IS_TEXT.

Parameters

mixed $value Value to check

Returns: boolean

Definition at line 464 of file Functions.php.

References flattenSingleValue().

Referenced by IS_NONTEXT().

                                                    {
                $value          = self::flattenSingleValue($value);
                return is_string($value);
        }       //      function IS_TEXT()

Here is the call graph for this function:

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::isCellValue ( $idx )

static

Definition at line 304 of file Functions.php.

Referenced by PHPExcel_Calculation_Statistical\AVEDEV(), PHPExcel_Calculation_Statistical\AVERAGE(), PHPExcel_Calculation_Statistical\COUNT(), PHPExcel_Calculation_Statistical\DEVSQ(), PHPExcel_Calculation_Statistical\STDEV(), and PHPExcel_Calculation_Statistical\STDEVP().

                                                 {
                return (substr_count($idx,'.') > 1);
        }

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::isMatrixValue ( $idx )

static

Definition at line 294 of file Functions.php.

Referenced by PHPExcel_Calculation_Statistical\AVERAGEA(), PHPExcel_Calculation_Statistical\KURT(), PHPExcel_Calculation_Statistical\SKEW(), PHPExcel_Calculation_Statistical\STDEVA(), PHPExcel_Calculation_Statistical\STDEVPA(), PHPExcel_Calculation_Statistical\VARA(), and PHPExcel_Calculation_Statistical\VARPA().

                                                   {
                return ((substr_count($idx,'.') <= 1) || (preg_match('/\.[A-Z]/',$idx) > 0));
        }

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::isValue ( $idx )

static

Definition at line 299 of file Functions.php.

Referenced by PHPExcel_Calculation_Statistical\VARA(), and PHPExcel_Calculation_Statistical\VARPA().

                                             {
                return (substr_count($idx,'.') == 0);
        }

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::N ( $value )

static

N.

Returns a value converted to a number

Parameters

value The value you want converted

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

Definition at line 507 of file Functions.php.

                                         {
                while (is_array($value)) {
                        $value = array_shift($value);
                }
                switch (gettype($value)) {
                        case 'double'   :
                        case 'float'    :
                        case 'integer'  :
                                return $value;
                                break;
                        case 'boolean'  :
                                return (integer) $value;
                                break;
                        case 'string'   :
                                //      Errors
                                if ((strlen($value) > 0) && ($value{0} == '#')) {
                                        return $value;
                                }
                                break;
                }
                return 0;
        }       //      function N()

static PHPExcel_Calculation_Functions::NA ( )

static

Definition at line 219 of file Functions.php.

                                    {
                return self::$_errorCodes['na'];
        }       //      function NA()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::NAME ( )

static

Definition at line 247 of file Functions.php.

                                      {
                return self::$_errorCodes['name'];
        }       //      function NAME()

static PHPExcel_Calculation_Functions::NaN ( )

static

Definition at line 233 of file Functions.php.

                                     {
                return self::$_errorCodes['num'];
        }       //      function NaN()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::NULL ( )

static

Definition at line 275 of file Functions.php.

Referenced by PHPExcel_Calculation_Statistical\_inverse_ncdf().

                                      {
                return self::$_errorCodes['null'];
        }       //      function NULL()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::REF ( )

static

Definition at line 261 of file Functions.php.

Referenced by PHPExcel_Calculation\_processTokenStack(), PHPExcel_Calculation\extractNamedRange(), PHPExcel_Calculation_LookupRef\HYPERLINK(), PHPExcel_Calculation_LookupRef\INDEX(), PHPExcel_Calculation_LookupRef\INDIRECT(), PHPExcel_Calculation_LookupRef\OFFSET(), and PHPExcel_Calculation_LookupRef\VLOOKUP().

                                     {
                return self::$_errorCodes['reference'];
        }       //      function REF()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::setCompatibilityMode ( $compatibilityMode )

static

Definition at line 116 of file Functions.php.

References $compatibilityMode.

                                                                        {
                if (($compatibilityMode == self::COMPATIBILITY_EXCEL) ||
                        ($compatibilityMode == self::COMPATIBILITY_GNUMERIC) ||
                        ($compatibilityMode == self::COMPATIBILITY_OPENOFFICE)) {
                        self::$compatibilityMode = $compatibilityMode;
                        return True;
                }
                return False;
        }       //      function setCompatibilityMode()

static PHPExcel_Calculation_Functions::setReturnDateType ( $returnDateType )

static

Definition at line 155 of file Functions.php.

Referenced by PHPExcel_Calculation_DateTime\_getDateValue(), PHPExcel_Calculation_DateTime\_getTimeValue(), PHPExcel_Writer_Excel5\save(), and PHPExcel_Writer_Excel2007\save().

                                                                  {
                if (($returnDateType == self::RETURNDATE_PHP_NUMERIC) ||
                        ($returnDateType == self::RETURNDATE_PHP_OBJECT) ||
                        ($returnDateType == self::RETURNDATE_EXCEL)) {
                        self::$ReturnDateType = $returnDateType;
                        return True;
                }
                return False;
        }       //      function setReturnDateType()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::TYPE ( $value )

static

TYPE.

Returns a number that identifies the type of a value

Parameters

value The value you want tested

Returns: number 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

Definition at line 546 of file Functions.php.

References flattenArrayIndexed(), and flattenSingleValue().

                                            {
                $value  = self::flattenArrayIndexed($value);
                if (is_array($value) && (count($value) > 1)) {
                        $a = array_keys($value);
                        $a = array_pop($a);
                        //      Range of cells is an error
                        if (self::isCellValue($a)) {
                                return 16;
                        //      Test for Matrix
                        } elseif (self::isMatrixValue($a)) {
                                return 64;
                        }
                } elseif(count($value) == 0) {
                        //      Empty Cell
                        return 1;
                }
                $value  = self::flattenSingleValue($value);
                if ((is_float($value)) || (is_int($value))) {
                                return 1;
                } elseif(is_bool($value)) {
                                return 4;
                } elseif(is_array($value)) {
                                return 64;
                                break;
                } elseif(is_string($value)) {
                        //      Errors
                        if ((strlen($value) > 0) && ($value{0} == '#')) {
                                return 16;
                        }
                        return 2;
                }
                return 0;
        }       //      function TYPE()

Here is the call graph for this function:

static PHPExcel_Calculation_Functions::VALUE ( )

static

Definition at line 289 of file Functions.php.

                                       {
                return self::$_errorCodes['value'];
        }       //      function VALUE()

Here is the caller graph for this function:

static PHPExcel_Calculation_Functions::VERSION ( )

static

VERSION.

Returns: string Version information

Definition at line 487 of file Functions.php.

                                         {
                return 'PHPExcel 1.7.6, 2011-02-27';
        }       //      function VERSION()

Field Documentation

PHPExcel_Calculation_Functions::$_errorCodes

staticprotected

Initial value:

 array( 'null'                          => '#NULL!',
                                                                                         'divisionbyzero'       => '#DIV/0!',
                                                                                         'value'                        => '#VALUE!',
                                                                                         'reference'            => '#REF!',
                                                                                         'name'                         => '#NAME?',
                                                                                         'num'                          => '#NUM!',
                                                                                         'na'                           => '#N/A',
                                                                                         'gettingdata'          => '#GETTING_DATA'
                                                                                   )