Collaboration diagram for PhpOffice\PhpSpreadsheet\Calculation\Functions:

Static Public Member Functions
static	setCompatibilityMode ($compatibilityMode)
	Set the Compatibility Mode. More...

static	getCompatibilityMode ()
	Return the current Compatibility Mode. More...

static	setReturnDateType ($returnDateType)
	Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object). More...

static	getReturnDateType ()
	Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object). More...

static	DUMMY ()
	DUMMY. More...

static	DIV0 ()
	DIV0. More...

static	NA ()
	NA. More...

static	NAN ()
	NaN. More...

static	NAME ()
	NAME. More...

static	REF ()
	REF. More...

static	null ()
	NULL. More...

static	VALUE ()
	VALUE. More...

static	isMatrixValue ($idx)

static	isValue ($idx)

static	isCellValue ($idx)

static	ifCondition ($condition)

static	errorType ($value='')
	ERROR_TYPE. More...

static	isBlank ($value=null)
	IS_BLANK. More...

static	isErr ($value='')
	IS_ERR. More...

static	isError ($value='')
	IS_ERROR. More...

static	isNa ($value='')
	IS_NA. More...

static	isEven ($value=null)
	IS_EVEN. More...

static	isOdd ($value=null)
	IS_ODD. More...

static	isNumber ($value=null)
	IS_NUMBER. More...

static	isLogical ($value=null)
	IS_LOGICAL. More...

static	isText ($value=null)
	IS_TEXT. More...

static	isNonText ($value=null)
	IS_NONTEXT. More...

static	n ($value=null)
	N. More...

static	TYPE ($value=null)
	TYPE. More...

static	flattenArray ($array)
	Convert a multi-dimensional array to a simple 1-dimensional array. More...

static	flattenArrayIndexed ($array)
	Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing. More...

static	flattenSingleValue ($value='')
	Convert an array to a single scalar value by extracting the first element. More...

static	isFormula ($cellReference='', ?Cell $pCell=null)
	ISFORMULA. More...

Data Fields
const	PRECISION = 8.88E-016

const	M_2DIVPI = 0.63661977236758134307553505349006
	2 / PI. More...

const	COMPATIBILITY_EXCEL = 'Excel'
	constants More...

const	COMPATIBILITY_GNUMERIC = 'Gnumeric'

const	COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc'

const	RETURNDATE_PHP_NUMERIC = 'P'

const	RETURNDATE_UNIX_TIMESTAMP = 'P'

const	RETURNDATE_PHP_OBJECT = 'O'

const	RETURNDATE_PHP_DATETIME_OBJECT = 'O'

const	RETURNDATE_EXCEL = 'E'

Static Protected Attributes
static	$compatibilityMode = self::COMPATIBILITY_EXCEL

static	$returnDateType = self::RETURNDATE_EXCEL

static	$errorCodes

Static Private Member Functions
static	operandSpecialHandling ($operand)

Detailed Description

Definition at line 8 of file Functions.php.

Member Function Documentation

◆ DIV0()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::DIV0 ( )

static

DIV0.

Returns: string #Not Yet Implemented

Definition at line 153 of file Functions.php.

    {
        return self::$errorCodes['divisionbyzero'];
    }

Here is the caller graph for this function:

◆ DUMMY()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::DUMMY ( )

static

DUMMY.

Returns: string #Not Yet Implemented

Definition at line 143 of file Functions.php.

    {
        return '#Not Yet Implemented';
    }

◆ errorType()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::errorType ( $value = '' )

static

ERROR_TYPE.

Parameters

mixed $value Value to check

Returns: int|string

Definition at line 308 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        $i = 1;
        foreach (self::$errorCodes as $errorCode) {
            if ($value === $errorCode) {
                return $i;
            }
            ++$i;
        }
 
        return self::NA();
    }

References $errorCode, $i, PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\NA().

Here is the call graph for this function:

◆ flattenArray()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray ( $array )

static

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

Parameters

array | mixed $array Array to be flattened

Returns: array Flattened array

Definition at line 583 of file Functions.php.

    {
        if (!is_array($array)) {
            return (array) $array;
        }
 
        $arrayValues = [];
        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;
    }

Here is the caller graph for this function:

◆ flattenArrayIndexed()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArrayIndexed ( $array )

static

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

Parameters

array | mixed $array Array to be flattened

Returns: array Flattened array

Definition at line 616 of file Functions.php.

    {
        if (!is_array($array)) {
            return (array) $array;
        }
 
        $arrayValues = [];
        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;
    }

Here is the caller graph for this function:

◆ flattenSingleValue()

static PhpOffice\PhpSpreadsheet\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 649 of file Functions.php.

    {
        while (is_array($value)) {
            $value = array_shift($value);
        }
 
        return $value;
    }

Here is the caller graph for this function:

◆ getCompatibilityMode()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::getCompatibilityMode ( )

static

Return the current Compatibility Mode.

Returns: string Compatibility Mode Possible Return values are: Functions::COMPATIBILITY_EXCEL 'Excel' Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'

Definition at line 93 of file Functions.php.

    {
        return self::$compatibilityMode;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\$compatibilityMode.

Here is the caller graph for this function:

◆ getReturnDateType()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::getReturnDateType ( )

static

Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).

Returns: string Return Date Format Possible Return values are: Functions::RETURNDATE_UNIX_TIMESTAMP 'P' Functions::RETURNDATE_PHP_DATETIME_OBJECT 'O' Functions::RETURNDATE_EXCEL 'E'

Definition at line 133 of file Functions.php.

    {
        return self::$returnDateType;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\$returnDateType.

Here is the caller graph for this function:

◆ ifCondition()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::ifCondition ( $condition )

static

Definition at line 249 of file Functions.php.

    {
        $condition = self::flattenSingleValue($condition);
 
        if ($condition === '') {
            $condition = '=""';
        }
        if (!is_string($condition) || !in_array($condition[0], ['>', '<', '='])) {
            $condition = self::operandSpecialHandling($condition);
            if (is_bool($condition)) {
                return '=' . ($condition ? 'TRUE' : 'FALSE');
            } elseif (!is_numeric($condition)) {
                $condition = Calculation::wrapResult(strtoupper($condition));
            }
 
            return str_replace('""""', '""', '=' . $condition);
        }
        preg_match('/(=|<[>=]?|>=?)(.*)/', $condition, $matches);
        [, $operator, $operand] = $matches;
 
        $operand = self::operandSpecialHandling($operand);
        if (is_numeric(trim($operand, '"'))) {
            $operand = trim($operand, '"');
        } elseif (!is_numeric($operand) && $operand !== 'FALSE' && $operand !== 'TRUE') {
            $operand = str_replace('"', '""', $operand);
            $operand = Calculation::wrapResult(strtoupper($operand));
        }
 
        return str_replace('""""', '""', $operator . $operand);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), PhpOffice\PhpSpreadsheet\Calculation\Functions\operandSpecialHandling(), and PhpOffice\PhpSpreadsheet\Calculation\Calculation\wrapResult().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Database\DatabaseAbstract\buildCondition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isBlank()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isBlank ( $value = null )

static

IS_BLANK.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 330 of file Functions.php.

    {
        if ($value !== null) {
            $value = self::flattenSingleValue($value);
        }
 
        return $value === null;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue().

Here is the call graph for this function:

◆ isCellValue()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isCellValue ( $idx )

static

Definition at line 244 of file Functions.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Statistical\Averages\average(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Averages\averageDeviations(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Counts\COUNTA(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\AggregateBase\isAcceptedCountable(), PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sum\sumErroringStrings(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Deviations\sumSquares(), and PhpOffice\PhpSpreadsheet\Calculation\Statistical\AggregateBase\testAcceptedBoolean().

Here is the caller graph for this function:

◆ isErr()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isErr ( $value = '' )

static

IS_ERR.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 346 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        return self::isError($value) && (!self::isNa(($value)));
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), PhpOffice\PhpSpreadsheet\Calculation\Functions\isError(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\isNa().

Here is the call graph for this function:

◆ isError()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isError ( $value = '' )

static

IS_ERROR.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 360 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        if (!is_string($value)) {
            return false;
        }
 
        return in_array($value, self::$errorCodes);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Logical\Conditional\IFERROR(), PhpOffice\PhpSpreadsheet\Calculation\Functions\isErr(), PhpOffice\PhpSpreadsheet\Calculation\Functions\isText(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\processTokenStack(), PhpOffice\PhpSpreadsheet\Calculation\Logical\Conditional\statementIf(), PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sum\sumErroringStrings(), PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sum\sumIgnoringStrings(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\LookupRefValidations\validateInt(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCellFormula().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEven()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isEven ( $value = null )

static

IS_EVEN.

Parameters

mixed $value Value to check

Returns: bool|string

Definition at line 392 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        if ($value === null) {
            return self::NAME();
        } elseif ((is_bool($value)) || ((is_string($value)) && (!is_numeric($value)))) {
            return self::VALUE();
        }
 
        return $value % 2 == 0;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), PhpOffice\PhpSpreadsheet\Calculation\Functions\NAME(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\VALUE().

Here is the call graph for this function:

◆ isFormula()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isFormula	(		$cellReference = `''`,
		?Cell	$pCell = `null`
	)

static

ISFORMULA.

Parameters

mixed	$cellReference	The cell to check
Cell	$pCell	The current cell (containing this formula)

Returns: bool|string

Definition at line 666 of file Functions.php.

    {
        if ($pCell === null) {
            return self::REF();
        }
 
        preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/i', $cellReference, $matches);
 
        $cellReference = $matches[6] . $matches[7];
        $worksheetName = str_replace("''", "'", trim($matches[2], "'"));
 
        $worksheet = (!empty($worksheetName))
            ? $pCell->getWorksheet()->getParent()->getSheetByName($worksheetName)
            : $pCell->getWorksheet();
 
        return $worksheet->getCell($cellReference)->isFormula();
    }

References PhpOffice\PhpSpreadsheet\Calculation\Calculation\CALCULATION_REGEXP_CELLREF, and PhpOffice\PhpSpreadsheet\Calculation\Functions\REF().

Here is the call graph for this function:

◆ isLogical()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isLogical ( $value = null )

static

IS_LOGICAL.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 450 of file Functions.php.

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

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue().

Here is the call graph for this function:

◆ isMatrixValue()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isMatrixValue ( $idx )

static

Definition at line 234 of file Functions.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Statistical\Averages\averageA(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Deviations\kurtosis(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Deviations\skew(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Variances\VARA(), and PhpOffice\PhpSpreadsheet\Calculation\Statistical\Variances\VARPA().

Here is the caller graph for this function:

◆ isNa()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isNa ( $value = '' )

static

IS_NA.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 378 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        return $value === self::NA();
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\NA().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Logical\Conditional\IFNA(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\isErr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNonText()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isNonText ( $value = null )

static

IS_NONTEXT.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 478 of file Functions.php.

    {
        return !self::isText($value);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\isText().

Here is the call graph for this function:

◆ isNumber()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isNumber ( $value = null )

static

IS_NUMBER.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 432 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        if (is_string($value)) {
            return false;
        }
 
        return is_numeric($value);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue().

Here is the call graph for this function:

◆ isOdd()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isOdd ( $value = null )

static

IS_ODD.

Parameters

mixed $value Value to check

Returns: bool|string

Definition at line 412 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        if ($value === null) {
            return self::NAME();
        } elseif ((is_bool($value)) || ((is_string($value)) && (!is_numeric($value)))) {
            return self::VALUE();
        }
 
        return abs($value) % 2 == 1;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), PhpOffice\PhpSpreadsheet\Calculation\Functions\NAME(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\VALUE().

Here is the call graph for this function:

◆ isText()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isText ( $value = null )

static

IS_TEXT.

Parameters

mixed $value Value to check

Returns: bool

Definition at line 464 of file Functions.php.

    {
        $value = self::flattenSingleValue($value);
 
        return is_string($value) && !self::isError($value);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\isError().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Functions\isNonText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValue()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::isValue ( $idx )

static

Definition at line 239 of file Functions.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Statistical\Variances\VARA(), and PhpOffice\PhpSpreadsheet\Calculation\Statistical\Variances\VARPA().

Here is the caller graph for this function:

◆ n()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::n ( $value = null )

static

N.

Returns a value converted to a number

Parameters

null | mixed $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 499 of file Functions.php.

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

◆ NA()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::NA ( )

static

NA.

Excel Function: =NA()

Returns the error value #N/A #N/A is the error value that means "no value is available."

Returns: string #N/A!

Definition at line 169 of file Functions.php.

    {
        return self::$errorCodes['na'];
    }

Here is the caller graph for this function:

◆ NAME()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::NAME ( )

static

NAME.

Returns the error value NAME?

Returns: string NAME?

Definition at line 193 of file Functions.php.

    {
        return self::$errorCodes['name'];
    }

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Functions\isEven(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\isOdd().

Here is the caller graph for this function:

◆ NAN()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::NAN ( )

static

NaN.

Returns the error value #NUM!

Returns: string #NUM!

Definition at line 181 of file Functions.php.

    {
        return self::$errorCodes['num'];
    }

Here is the caller graph for this function:

◆ null()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::null ( )

static

NULL.

Returns the error value #NULL!

Returns: string #NULL!

Definition at line 217 of file Functions.php.

    {
        return self::$errorCodes['null'];
    }

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Calculation\processTokenStack().

Here is the caller graph for this function:

◆ operandSpecialHandling()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::operandSpecialHandling ( $operand )

staticprivate

Definition at line 280 of file Functions.php.

    {
        if (is_numeric($operand) || is_bool($operand)) {
            return $operand;
        } elseif (strtoupper($operand) === Calculation::getTRUE() || strtoupper($operand) === Calculation::getFALSE()) {
            return strtoupper($operand);
        }
 
        // Check for percentage
        if (preg_match('/^\-?\d*\.?\d*\s?\%$/', $operand)) {
            return ((float) rtrim($operand, '%')) / 100;
        }
 
        // Check for dates
        if (($dateValueOperand = Date::stringToExcel($operand)) !== false) {
            return $dateValueOperand;
        }
 
        return $operand;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Calculation\getFALSE(), and PhpOffice\PhpSpreadsheet\Calculation\Calculation\getTRUE().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Functions\ifCondition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ REF()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::REF ( )

static

REF.

Returns the error value REF!

Returns: string REF!

Definition at line 205 of file Functions.php.

    {
        return self::$errorCodes['reference'];
    }

Here is the caller graph for this function:

◆ setCompatibilityMode()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::setCompatibilityMode ( $compatibilityMode )

static

Set the Compatibility Mode.

Parameters

string $compatibilityMode Compatibility Mode Permitted values are: Functions::COMPATIBILITY_EXCEL 'Excel' Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'

Returns: bool (Success or Failure)

Definition at line 69 of file Functions.php.

    {
        if (
            ($compatibilityMode == self::COMPATIBILITY_EXCEL) ||
            ($compatibilityMode == self::COMPATIBILITY_GNUMERIC) ||
            ($compatibilityMode == self::COMPATIBILITY_OPENOFFICE)
        ) {
            self::$compatibilityMode = $compatibilityMode;
 
            return true;
        }
 
        return false;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\$compatibilityMode.

◆ setReturnDateType()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::setReturnDateType ( $returnDateType )

static

Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).

Parameters

string $returnDateType Return Date Format Permitted values are: Functions::RETURNDATE_UNIX_TIMESTAMP 'P' Functions::RETURNDATE_PHP_DATETIME_OBJECT 'O' Functions::RETURNDATE_EXCEL 'E'

Returns: bool Success or failure

Definition at line 109 of file Functions.php.

    {
        if (
            ($returnDateType == self::RETURNDATE_UNIX_TIMESTAMP) ||
            ($returnDateType == self::RETURNDATE_PHP_DATETIME_OBJECT) ||
            ($returnDateType == self::RETURNDATE_EXCEL)
        ) {
            self::$returnDateType = $returnDateType;
 
            return true;
        }
 
        return false;
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\$returnDateType.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\dynamicFilterDateRange(), PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers\getDateValue(), PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers\getTimeValue(), PhpOffice\PhpSpreadsheet\Writer\Xls\save(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\save(), and PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\VALUE().

Here is the caller graph for this function:

◆ TYPE()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::TYPE ( $value = null )

static

TYPE.

Returns a number that identifies the type of a value

Parameters

null | mixed $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 539 of file Functions.php.

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

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenArrayIndexed(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue().

Here is the call graph for this function:

◆ VALUE()

static PhpOffice\PhpSpreadsheet\Calculation\Functions::VALUE ( )

static

VALUE.

Returns the error value VALUE!

Returns: string VALUE!

Definition at line 229 of file Functions.php.

    {
        return self::$errorCodes['value'];
    }

Here is the caller graph for this function:

Field Documentation

◆ $compatibilityMode

PhpOffice\PhpSpreadsheet\Calculation\Functions::$compatibilityMode = self::COMPATIBILITY_EXCEL

staticprotected

Definition at line 33 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Functions\getCompatibilityMode(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\setCompatibilityMode().

◆ $errorCodes

PhpOffice\PhpSpreadsheet\Calculation\Functions::$errorCodes

staticprotected

Initial value:

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

Definition at line 47 of file Functions.php.

◆ $returnDateType

PhpOffice\PhpSpreadsheet\Calculation\Functions::$returnDateType = self::RETURNDATE_EXCEL

staticprotected

Definition at line 40 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Functions\getReturnDateType(), and PhpOffice\PhpSpreadsheet\Calculation\Functions\setReturnDateType().

◆ COMPATIBILITY_EXCEL

const PhpOffice\PhpSpreadsheet\Calculation\Functions::COMPATIBILITY_EXCEL = 'Excel'

constants

Definition at line 18 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\excelToDateTimeObject(), PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Ceiling\floorCheck1Arg(), PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Floor\floorCheck1Arg(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\AggregateBase\testAcceptedBoolean(), and PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\DateParts\weirdCondition().

◆ COMPATIBILITY_GNUMERIC

const PhpOffice\PhpSpreadsheet\Calculation\Functions::COMPATIBILITY_GNUMERIC = 'Gnumeric'

Definition at line 19 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\ChiSquared\distributionLeftTail(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\ChiSquared\distributionRightTail(), PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Factorial\fact(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\AggregateBase\isAcceptedCountable(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\Binomial\negative(), and PhpOffice\PhpSpreadsheet\Calculation\Engineering\ConvertBase\validateValue().

◆ COMPATIBILITY_OPENOFFICE

const PhpOffice\PhpSpreadsheet\Calculation\Functions::COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc'

Definition at line 20 of file Functions.php.

◆ M_2DIVPI

const PhpOffice\PhpSpreadsheet\Calculation\Functions::M_2DIVPI = 0.63661977236758134307553505349006

2 / PI.

Definition at line 15 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\StudentT\calculateDistribution().

◆ PRECISION

const PhpOffice\PhpSpreadsheet\Calculation\Functions::PRECISION = 8.88E-016

Definition at line 10 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\Beta\betaFraction(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\GammaBase\calculateInverse(), PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\Beta\calculateInverse(), PhpOffice\PhpSpreadsheet\Calculation\Engineering\ErfC\erfcValue(), PhpOffice\PhpSpreadsheet\Calculation\Engineering\Erf\erfValue(), and PhpOffice\PhpSpreadsheet\Calculation\Statistical\Distributions\NewtonRaphson\execute().

◆ RETURNDATE_EXCEL

const PhpOffice\PhpSpreadsheet\Calculation\Functions::RETURNDATE_EXCEL = 'E'

Definition at line 26 of file Functions.php.

◆ RETURNDATE_PHP_DATETIME_OBJECT

const PhpOffice\PhpSpreadsheet\Calculation\Functions::RETURNDATE_PHP_DATETIME_OBJECT = 'O'

Definition at line 25 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers\returnIn3FormatsArray(), and PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers\returnIn3FormatsObject().

◆ RETURNDATE_PHP_NUMERIC

const PhpOffice\PhpSpreadsheet\Calculation\Functions::RETURNDATE_PHP_NUMERIC = 'P'

Definition at line 22 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\dynamicFilterDateRange().

◆ RETURNDATE_PHP_OBJECT

const PhpOffice\PhpSpreadsheet\Calculation\Functions::RETURNDATE_PHP_OBJECT = 'O'

Definition at line 24 of file Functions.php.

◆ RETURNDATE_UNIX_TIMESTAMP

const PhpOffice\PhpSpreadsheet\Calculation\Functions::RETURNDATE_UNIX_TIMESTAMP = 'P'

Definition at line 23 of file Functions.php.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Time\fromHMS(), PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\TimeValue\fromString(), and PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Helpers\returnIn3FormatsFloat().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Calculation/Functions.php

Static Public Member Functions

Data Fields

Static Protected Attributes

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ DIV0()

◆ DUMMY()

◆ errorType()

◆ flattenArray()

◆ flattenArrayIndexed()

◆ flattenSingleValue()

◆ getCompatibilityMode()

◆ getReturnDateType()

◆ ifCondition()

◆ isBlank()

◆ isCellValue()

◆ isErr()

◆ isError()

◆ isEven()

◆ isFormula()

◆ isLogical()

◆ isMatrixValue()

◆ isNa()

◆ isNonText()

◆ isNumber()

◆ isOdd()

◆ isText()

◆ isValue()

◆ n()

◆ NA()

◆ NAME()

◆ NAN()

◆ null()

◆ operandSpecialHandling()

◆ REF()

◆ setCompatibilityMode()

◆ setReturnDateType()

◆ TYPE()

◆ VALUE()

Field Documentation

◆ $compatibilityMode

◆ $errorCodes

◆ $returnDateType

◆ COMPATIBILITY_EXCEL

◆ COMPATIBILITY_GNUMERIC

◆ COMPATIBILITY_OPENOFFICE

◆ M_2DIVPI

◆ PRECISION

◆ RETURNDATE_EXCEL

◆ RETURNDATE_PHP_DATETIME_OBJECT

◆ RETURNDATE_PHP_NUMERIC

◆ RETURNDATE_PHP_OBJECT

◆ RETURNDATE_UNIX_TIMESTAMP