Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_CalcEngine_CyclicReferenceStack
  • PHPExcel_CalcEngine_Logger
  • PHPExcel_Calculation
  • PHPExcel_Calculation_Database
  • PHPExcel_Calculation_DateTime
  • PHPExcel_Calculation_Engineering
  • PHPExcel_Calculation_ExceptionHandler
  • PHPExcel_Calculation_Financial
  • PHPExcel_Calculation_FormulaParser
  • PHPExcel_Calculation_FormulaToken
  • PHPExcel_Calculation_Function
  • PHPExcel_Calculation_Functions
  • PHPExcel_Calculation_Logical
  • PHPExcel_Calculation_LookupRef
  • PHPExcel_Calculation_MathTrig
  • PHPExcel_Calculation_Statistical
  • PHPExcel_Calculation_TextData
  • PHPExcel_Calculation_Token_Stack

Exceptions

  • PHPExcel_Calculation_Exception

Functions

  • acosh
  • asinh
  • atanh
  • mb_str_replace
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Calculation_Functions

PHPExcel_Calculation_Functions

Package: PHPExcel\Calculation
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Calculation/Functions.php
Methods summary
public static boolean
# setCompatibilityMode( string $compatibilityMode )

Set the Compatibility Mode

Set the Compatibility Mode

Parameters

$compatibilityMode

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

Returns

boolean
(Success or Failure)

Category

Function Configuration
public static string
# getCompatibilityMode( )

Return the current Compatibility Mode

Return the current Compatibility Mode

Returns

string

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

Category

Function Configuration
public static boolean
# setReturnDateType( string $returnDateType )

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

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

Parameters

$returnDateType

Return Date Format Permitted values are: PHPExcel_Calculation_Functions::RETURNDATE_PHP_NUMERIC 'P' PHPExcel_Calculation_Functions::RETURNDATE_PHP_OBJECT 'O' PHPExcel_Calculation_Functions::RETURNDATE_EXCEL 'E'

Returns

boolean
Success or failure

Category

Function Configuration
public static string
# getReturnDateType( )

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

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: PHPExcel_Calculation_Functions::RETURNDATE_PHP_NUMERIC 'P' PHPExcel_Calculation_Functions::RETURNDATE_PHP_OBJECT 'O' PHPExcel_Calculation_Functions::RETURNDATE_EXCEL 'E'

Category

Function Configuration
public static string
# DUMMY( )

DUMMY

DUMMY

Returns

string

Not Yet Implemented

Category

Error Returns
public static string
# DIV0( )

DIV0

DIV0

Returns

string

Not Yet Implemented

Category

Error Returns
public static string
# NA( )

NA

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!

Category

Logical Functions
public static string
# NaN( )

NaN

NaN

Returns the error value #NUM!

Returns

string

NUM!

Category

Error Returns
public static string
# NAME( )

NAME

NAME

Returns the error value #NAME?

Returns

string

NAME?

Category

Error Returns
public static string
# REF( )

REF

REF

Returns the error value #REF!

Returns

string

REF!

Category

Error Returns
public static string
# NULL( )

NULL

NULL

Returns the error value #NULL!

Returns

string

NULL!

Category

Error Returns
public static string
# VALUE( )

VALUE

VALUE

Returns the error value #VALUE!

Returns

string

VALUE!

Category

Error Returns
public static
# isMatrixValue( $idx )
public static
# isValue( $idx )
public static
# isCellValue( $idx )
public static
# _ifCondition( $condition )
public static boolean
# ERROR_TYPE( mixed $value = '' )

ERROR_TYPE

ERROR_TYPE

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_BLANK( mixed $value = NULL )

IS_BLANK

IS_BLANK

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_ERR( mixed $value = '' )

IS_ERR

IS_ERR

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_ERROR( mixed $value = '' )

IS_ERROR

IS_ERROR

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_NA( mixed $value = '' )

IS_NA

IS_NA

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_EVEN( mixed $value = NULL )

IS_EVEN

IS_EVEN

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_ODD( mixed $value = NULL )

IS_ODD

IS_ODD

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_NUMBER( mixed $value = NULL )

IS_NUMBER

IS_NUMBER

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_LOGICAL( mixed $value = NULL )

IS_LOGICAL

IS_LOGICAL

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_TEXT( mixed $value = NULL )

IS_TEXT

IS_TEXT

Parameters

$value
Value to check

Returns

boolean
public static boolean
# IS_NONTEXT( mixed $value = NULL )

IS_NONTEXT

IS_NONTEXT

Parameters

$value
Value to check

Returns

boolean
public static string
# VERSION( )

VERSION

VERSION

Returns

string
Version information
public static number
# N( value $value = NULL )

N

N

Returns a value converted to a number

Parameters

$value
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

public static number
# TYPE( value $value = NULL )

TYPE

TYPE

Returns a number that identifies the type of a value

Parameters

$value
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

public static array
# flattenArray( array $array )

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

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

Parameters

$array
Array to be flattened

Returns

array
Flattened array
public static array
# flattenArrayIndexed( array $array )

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

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

Parameters

$array
Array to be flattened

Returns

array
Flattened array
public static mixed
# flattenSingleValue( mixed $value = '' )

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

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

Parameters

$value
Array or scalar value

Returns

mixed
Constants summary
string COMPATIBILITY_EXCEL

constants

constants

# 'Excel'
string COMPATIBILITY_GNUMERIC
# 'Gnumeric'
string COMPATIBILITY_OPENOFFICE
# 'OpenOfficeCalc'
string RETURNDATE_PHP_NUMERIC
# 'P'
string RETURNDATE_PHP_OBJECT
# 'O'
string RETURNDATE_EXCEL
# 'E'
Properties summary
protected static string $compatibilityMode

Compatibility mode to use for error checking and responses

Compatibility mode to use for error checking and responses

# PHPExcel_Calculation_Functions::COMPATIBILITY_EXCEL
protected static string $ReturnDateType

Data Type to use when returning date values

Data Type to use when returning date values

# PHPExcel_Calculation_Functions::RETURNDATE_EXCEL
protected static array $_errorCodes

List of error codes

List of error codes

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