Documentation

Functions
in package

Table of Contents

Constants

COMPATIBILITY_EXCEL  = 'Excel'
COMPATIBILITY_GNUMERIC  = 'Gnumeric'
COMPATIBILITY_OPENOFFICE  = 'OpenOfficeCalc'
M_2DIVPI  = 0.6366197723675814
2 / PI.
NOT_YET_IMPLEMENTED  = '#Not Yet Implemented'
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.

Properties

$compatibilityMode  : string
Compatibility mode to use for error checking and responses.
$returnDateType  : string
Data Type to use when returning date values.

Methods

DUMMY()  : string
DUMMY.
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()  : string
isCellValue()  : bool
isMatrixValue()  : bool
isValue()  : bool
scalar()  : 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
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

NOT_YET_IMPLEMENTED

public mixed NOT_YET_IMPLEMENTED = '#Not Yet Implemented'

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

DUMMY()

DUMMY.

public static DUMMY() : string
Return values
string —

#Not Yet Implemented

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(mixed $array) : array<string|int, mixed>
Parameters
$array : 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

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) : string
Parameters
$condition : mixed
Return values
string

isCellValue()

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

isMatrixValue()

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

isValue()

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

scalar()

public static scalar(mixed $value) : mixed
Parameters
$value : 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

operandSpecialHandling()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results