PHPExcel_Calculation
[ class tree: PHPExcel_Calculation ] [ index: PHPExcel_Calculation ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
Calculation.php
FormulaParser.php
FormulaToken.php
Function.php
Functions.php

Classes:
PHPExcel_Calculation
PHPExcel_Calculation_FormulaParser
PHPExcel_Calculation_FormulaToken
PHPExcel_Calculation_Function
PHPExcel_Calculation_Functions

Class: PHPExcel_Calculation

Source Location: /PHPExcel/Calculation.php

Class Overview




PHPExcel_Calculation (Singleton)




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


        




Variables






Constants






Methods
























Class Details



[line 62]

PHPExcel_Calculation (Singleton)

PHPExcel_Calculation (Singleton)





Tags:





  

    copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
static $returnArrayAsType =  self::RETURN_ARRAY_AS_ARRAY

	
[line 68]

  



Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
static $_instance = 

	
[line 103]

  Instance of this class

Instance of this class





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Calculation
    

      

	



	
[ Top ]


	
	

	
$_calculationCache = array ( )

	
[line 82]

  Calculation cache

Calculation cache





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_calculationCacheEnabled =  true

	
[line 89]

  Calculation cache enabled

Calculation cache enabled





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_calculationCacheExpirationTime =  0.01

	
[line 96]

  Calculation cache expiration time

Calculation cache expiration time





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      float
    

      

	



	
[ Top ]


	
	

	
$_functionMappings =  null

	
[line 75]

  Function mappings (from Excel to PHPExcel)

Function mappings (from Excel to PHPExcel)





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method getArrayReturnType [line 139]

	

    

    

		static string getArrayReturnType(
)
    

    


	
		Return the Array Return Type (Array or Value of first element in the array)

Return the Array Return Type (Array or Value of first element in the array)





Tags:





  

    return:  Array return type
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method getInstance [line 110]

	

    

    

		static PHPExcel_Calculation getInstance(
)
    

    


	
		Get an instance of this class

Get an instance of this class





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
static method setArrayReturnType [line 124]

	

    

    

		static boolean setArrayReturnType(
string
$returnType)
    

    


	
		Set the Array Return Type (Array or Value of first element in the array)

Set the Array Return Type (Array or Value of first element in the array)





Tags:





  

    return:  Success or failure
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $returnType  
        Array return type
      

        

    


        
[ Top ]

  


  

	
	
constructor __construct [line 147]

	

    

    

		PHPExcel_Calculation __construct(
)
    

    


	
		Create a new PHPExcel_Calculation

Create a new PHPExcel_Calculation





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method calculate [line 558]

	

    

    

		mixed calculate(
[
$pCell = null])
    

    


	
		Calculate cell value (using formula)

Calculate cell value (using formula)





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Cell  
        $pCell  
        Cell to calculate
      

        

    


        
[ Top ]

  

  

	
	
method clearCalculationCache [line 529]

	

    

    

		void clearCalculationCache(
)
    

    


	
		Clear calculation cache

Clear calculation cache





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method extractCell [line 844]

	

    

    

		mixed extractCell(
[string
$reference = 'A1'], [
$pCell = null])
    

    


	
		Extract cell

Extract cell





Tags:





  

    return:  Value
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $reference  
        
      

          

        PHPExcel_Cell  
        $pCell  
        
      

        

    


        
[ Top ]

  

  

	
	
method extractRange [line 792]

	

    

    

		mixed extractRange(
[string
$pRange = 'A1'], [
$pSheet = null])
    

    


	
		Extract range values

Extract range values





Tags:





  

    return:  Array of values in range if range contains more than one element. Otherwise, a single value is returned.
  

  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pRange  
        String based range representation
      

          

        PHPExcel_Worksheet  
        $pSheet  
        Worksheet
      

        

    


        
[ Top ]

  

  

	
	
method getCalculationCacheEnabled [line 512]

	

    

    

		boolean getCalculationCacheEnabled(
)
    

    


	
		Is calculation caching enabled?

Is calculation caching enabled?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getCalculationCacheExpirationTime [line 538]

	

    

    

		float getCalculationCacheExpirationTime(
)
    

    


	
		Get calculation cache expiration time

Get calculation cache expiration time





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isImplemented [line 859]

	

    

    

		boolean isImplemented(
[string
$pFunction = ''])
    

    


	
		Is a specific function implemented?

Is a specific function implemented?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pFunction  
        Function
      

        

    


        
[ Top ]

  

  

	
	
method listFunctionNames [line 895]

	

    

    

		array listFunctionNames(
)
    

    


	
		Get a list of implemented Excel function names

Get a list of implemented Excel function names





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method listFunctions [line 873]

	

    

    

		array listFunctions(
)
    

    


	
		Get a list of implemented functions

Get a list of implemented functions





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setCalculationCacheEnabled [line 521]

	

    

    

		void setCalculationCacheEnabled(
boolean
$pValue)
    

    


	
		Enable/disable calculation cache

Enable/disable calculation cache





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setCalculationCacheExpirationTime [line 547]

	

    

    

		void setCalculationCacheExpirationTime(
[float
$pValue = 0.01])
    

    


	
		Set calculation cache expiration time

Set calculation cache expiration time





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        float  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 780]

	

    

    

		void __clone(
)
    

    


	
		__clone implementation.

__clone implementation. Cloning should not be allowed in a Singleton!





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
RETURN_ARRAY_AS_ARRAY =  'array'

	
[line 66]

  
  

	
[ Top ]


	
	

	
RETURN_ARRAY_AS_VALUE =  'value'

	
[line 65]

  constants

constants


  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:36:37 +0100 by phpDocumentor 1.4.1