Documentation

Functions

Table of Contents

COMPATIBILITY_EXCEL  = 'Excel'
COMPATIBILITY_GNUMERIC  = 'Gnumeric'
COMPATIBILITY_OPENOFFICE  = 'OpenOfficeCalc'
M_2DIVPI  = 0.6366197723675814
2 / PI.
PRECISION  = 8.88E-16
RETURNDATE_EXCEL  = 'E'
RETURNDATE_PHP_DATETIME_OBJECT  = 'O'
RETURNDATE_PHP_NUMERIC  = 'P'
Use of RETURNDATE_PHP_NUMERIC is discouraged - not 32-bit Y2038-safe, no timezone.
RETURNDATE_PHP_OBJECT  = 'O'
RETURNDATE_UNIX_TIMESTAMP  = 'P'
Use of RETURNDATE_UNIX_TIMESTAMP is discouraged - not 32-bit Y2038-safe, no timezone.
$compatibilityMode  : string
Compatibility mode to use for error checking and responses.
$returnDateType  : string
Data Type to use when returning date values.
DIV0()  : string
DIV0.
DUMMY()  : string
DUMMY.
errorType()  : array<string|int, mixed>|int|string
ERROR_TYPE.
expandDefinedName()  : string
flattenArray()  : array<string|int, mixed>
Convert a multi-dimensional array to a simple 1-dimensional array.
flattenArrayIndexed()  : array<string|int, mixed>
Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.
flattenSingleValue()  : mixed
Convert an array to a single scalar value by extracting the first element.
getCompatibilityMode()  : string
Return the current Compatibility Mode.
getReturnDateType()  : string
Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).
ifCondition()  : mixed
isBlank()  : array<string|int, mixed>|bool
IS_BLANK.
isCellValue()  : mixed
isErr()  : array<string|int, mixed>|bool
IS_ERR.
isError()  : array<string|int, mixed>|bool
IS_ERROR.
isEven()  : array<string|int, mixed>|bool|string
IS_EVEN.
isFormula()  : array<string|int, mixed>|bool|string
ISFORMULA.
isLogical()  : array<string|int, mixed>|bool
IS_LOGICAL.
isMatrixValue()  : mixed
isNa()  : array<string|int, mixed>|bool
IS_NA.
isNonText()  : array<string|int, mixed>|bool
IS_NONTEXT.
isNumber()  : array<string|int, mixed>|bool
IS_NUMBER.
isOdd()  : array<string|int, mixed>|bool|string
IS_ODD.
isText()  : array<string|int, mixed>|bool
IS_TEXT.
isValue()  : mixed
n()  : number|string
N.
NA()  : string
NA.
NAME()  : string
NAME.
NAN()  : string
NaN.
null()  : string
NULL.
REF()  : string
REF.
scalar()  : null|mixed
setCompatibilityMode()  : bool
Set the Compatibility Mode.
setReturnDateType()  : bool
Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP DateTime Object).
trimSheetFromCellReference()  : string
trimTrailingRange()  : string
TYPE()  : number
TYPE.
VALUE()  : string
VALUE.
operandSpecialHandling()  : mixed

Constants

COMPATIBILITY_EXCEL

public mixed COMPATIBILITY_EXCEL = 'Excel'

COMPATIBILITY_GNUMERIC

public mixed COMPATIBILITY_GNUMERIC = 'Gnumeric'

COMPATIBILITY_OPENOFFICE

public mixed COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc'

M_2DIVPI

2 / PI.

public mixed M_2DIVPI = 0.6366197723675814

RETURNDATE_EXCEL

public mixed RETURNDATE_EXCEL = 'E'

RETURNDATE_PHP_DATETIME_OBJECT

public mixed RETURNDATE_PHP_DATETIME_OBJECT = 'O'

RETURNDATE_PHP_NUMERIC

Use of RETURNDATE_PHP_NUMERIC is discouraged - not 32-bit Y2038-safe, no timezone.

public mixed RETURNDATE_PHP_NUMERIC = 'P'

RETURNDATE_PHP_OBJECT

public mixed RETURNDATE_PHP_OBJECT = 'O'

RETURNDATE_UNIX_TIMESTAMP

Use of RETURNDATE_UNIX_TIMESTAMP is discouraged - not 32-bit Y2038-safe, no timezone.

public mixed RETURNDATE_UNIX_TIMESTAMP = 'P'

Properties

$compatibilityMode

Compatibility mode to use for error checking and responses.

protected static string $compatibilityMode = self::COMPATIBILITY_EXCEL

$returnDateType

Data Type to use when returning date values.

protected static string $returnDateType = self::RETURNDATE_EXCEL

Methods

DIV0()

DIV0.

public static DIV0() : string
Tags
Deprecated

1.23.0

see
ExcelError::DIV0()

Use the DIV0() method in the Information\Error class instead

Return values
string

#Not Yet Implemented

DUMMY()

DUMMY.

public static DUMMY() : string
Return values
string

#Not Yet Implemented

errorType()

ERROR_TYPE.

public static errorType([mixed $value = '' ]) : array<string|int, mixed>|int|string
Parameters
$value : mixed = ''

Value to check

Tags
Deprecated

1.23.0

see
ExcelError::type()

Use the type() method in the Information\Error class instead

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

expandDefinedName()

public static expandDefinedName(string $coordinate, Cell $cell) : string
Parameters
$coordinate : string
$cell : Cell
Return values
string

flattenArray()

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

public static flattenArray(array<string|int, mixed>|mixed $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>|mixed

Array to be flattened

Return values
array<string|int, mixed>

Flattened array

flattenArrayIndexed()

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

public static flattenArrayIndexed(array<string|int, mixed>|mixed $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>|mixed

Array to be flattened

Return values
array<string|int, mixed>

Flattened array

flattenSingleValue()

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

public static flattenSingleValue([mixed $value = '' ]) : mixed
Parameters
$value : mixed = ''

Array or scalar value

Return values
mixed

getCompatibilityMode()

Return the current Compatibility Mode.

public static getCompatibilityMode() : string
Return values
string

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

getReturnDateType()

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

public static getReturnDateType() : string
Return values
string

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

ifCondition()

public static ifCondition(mixed $condition) : mixed
Parameters
$condition : mixed
Return values
mixed

isBlank()

IS_BLANK.

public static isBlank([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isBlank()

Use the isBlank() method in the Information\Value class instead

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

isCellValue()

public static isCellValue(mixed $idx) : mixed
Parameters
$idx : mixed
Return values
mixed

isErr()

IS_ERR.

public static isErr([mixed $value = '' ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = ''

Value to check

Tags
Deprecated

1.23.0

see
Value::isErr()

Use the isErr() method in the Information\Value class instead

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

isError()

IS_ERROR.

public static isError([mixed $value = '' ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = ''

Value to check

Tags
Deprecated

1.23.0

see
Value::isError()

Use the isError() method in the Information\Value class instead

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

isEven()

IS_EVEN.

public static isEven([mixed $value = null ]) : array<string|int, mixed>|bool|string
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isEven()

Use the isEven() method in the Information\Value class instead

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

isFormula()

ISFORMULA.

public static isFormula([mixed $cellReference = '' ][, Cell|null $cell = null ]) : array<string|int, mixed>|bool|string
Parameters
$cellReference : mixed = ''

The cell to check

$cell : Cell|null = null

The current cell (containing this formula)

Tags
Deprecated

1.23.0

see
Value::isFormula()

Use the isFormula() method in the Information\Value class instead

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

isLogical()

IS_LOGICAL.

public static isLogical([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isLogical()

Use the isLogical() method in the Information\Value class instead

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

isMatrixValue()

public static isMatrixValue(mixed $idx) : mixed
Parameters
$idx : mixed
Return values
mixed

isNa()

IS_NA.

public static isNa([mixed $value = '' ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = ''

Value to check

Tags
Deprecated

1.23.0

see
Value::isNa()

Use the isNa() method in the Information\Value class instead

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

isNonText()

IS_NONTEXT.

public static isNonText([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isNonText()

Use the isNonText() method in the Information\Value class instead

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

isNumber()

IS_NUMBER.

public static isNumber([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isNumber()

Use the isNumber() method in the Information\Value class instead

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

isOdd()

IS_ODD.

public static isOdd([mixed $value = null ]) : array<string|int, mixed>|bool|string
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isOdd()

Use the isOdd() method in the Information\Value class instead

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

isText()

IS_TEXT.

public static isText([mixed $value = null ]) : array<string|int, mixed>|bool
Parameters
$value : mixed = null

Value to check

Tags
Deprecated

1.23.0

see
Value::isText()

Use the isText() method in the Information\Value class instead

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

isValue()

public static isValue(mixed $idx) : mixed
Parameters
$idx : mixed
Return values
mixed

n()

N.

public static n([null|mixed $value = null ]) : number|string

Returns a value converted to a number

Parameters
$value : null|mixed = null

The value you want converted

Tags
Deprecated

1.23.0

see
Value::asNumber()

Use the asNumber() method in the Information\Value class instead

Return values
number|string

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

NA()

NA.

public static NA() : string

Excel Function: =NA()

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

Tags
Deprecated

1.23.0

see
ExcelError::NA()

Use the NA() method in the Information\Error class instead

Return values
string

#N/A!

NAME()

NAME.

public static NAME() : string

Returns the error value #NAME?

Tags
Deprecated

1.23.0

see
ExcelError::NAME()

Use the NAME() method in the Information\Error class instead

Return values
string

#NAME?

NAN()

NaN.

public static NAN() : string

Returns the error value #NUM!

Tags
Deprecated

1.23.0

see
ExcelError::NAN()

Use the NAN() method in the Information\Error class instead

Return values
string

#NUM!

null()

NULL.

public static null() : string

Returns the error value #NULL!

Tags
Deprecated

1.23.0

see
ExcelError::null()

Use the null() method in the Information\Error class instead

Return values
string

#NULL!

REF()

REF.

public static REF() : string

Returns the error value #REF!

Tags
Deprecated

1.23.0

see
ExcelError::REF()

Use the REF() method in the Information\Error class instead

Return values
string

#REF!

scalar()

public static scalar(mixed $value) : null|mixed
Parameters
$value : mixed
Return values
null|mixed

setCompatibilityMode()

Set the Compatibility Mode.

public static setCompatibilityMode(string $compatibilityMode) : bool
Parameters
$compatibilityMode : string

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

Return values
bool

(Success or Failure)

setReturnDateType()

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

public static setReturnDateType(string $returnDateType) : bool
Parameters
$returnDateType : string

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

Return values
bool

Success or failure

trimSheetFromCellReference()

public static trimSheetFromCellReference(string $coordinate) : string
Parameters
$coordinate : string
Return values
string

trimTrailingRange()

public static trimTrailingRange(string $coordinate) : string
Parameters
$coordinate : string
Return values
string

TYPE()

TYPE.

public static TYPE([null|mixed $value = null ]) : number

Returns a number that identifies the type of a value

Parameters
$value : null|mixed = null

The value you want tested

Tags
Deprecated

1.23.0

see
Value::type()

Use the type() method in the Information\Value class instead

Return values
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

VALUE()

VALUE.

public static VALUE() : string

Returns the error value #VALUE!

Tags
Deprecated

1.23.0

see
ExcelError::VALUE()

Use the VALUE() method in the Information\Error class instead

Return values
string

#VALUE!

operandSpecialHandling()

private static operandSpecialHandling(mixed $operand) : mixed
Parameters
$operand : mixed
Return values
mixed

Search results