PHPExcel_Calculation_Function Class Reference

Collaboration diagram for PHPExcel_Calculation_Function:

Public Member Functions
	__construct ($pCategory=NULL, $pExcelName=NULL, $pPHPExcelName=NULL)
	Create a new PHPExcel_Calculation_Function. More...
	getCategory ()
	Get Category (represented by CATEGORY_*) More...
	setCategory ($value=null)
	Set Category (represented by CATEGORY_*) More...
	getExcelName ()
	Get Excel name. More...
	setExcelName ($value)
	Set Excel name. More...
	getPHPExcelName ()
	Get PHPExcel name. More...
	setPHPExcelName ($value)
	Set PHPExcel name. More...

Data Fields
const	CATEGORY_CUBE = 'Cube'
const	CATEGORY_DATABASE = 'Database'
const	CATEGORY_DATE_AND_TIME = 'Date and Time'
const	CATEGORY_ENGINEERING = 'Engineering'
const	CATEGORY_FINANCIAL = 'Financial'
const	CATEGORY_INFORMATION = 'Information'
const	CATEGORY_LOGICAL = 'Logical'
const	CATEGORY_LOOKUP_AND_REFERENCE = 'Lookup and Reference'
const	CATEGORY_MATH_AND_TRIG = 'Math and Trig'
const	CATEGORY_STATISTICAL = 'Statistical'
const	CATEGORY_TEXT_AND_DATA = 'Text and Data'

Private Attributes
	$_category
	$_excelName
	$_phpExcelName

Detailed Description

Definition at line 36 of file Function.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Calculation_Function::__construct	(		$pCategory = NULL,
			$pExcelName = NULL,
			$pPHPExcelName = NULL
	)

Create a new PHPExcel_Calculation_Function.

Parameters

string	$pCategory	Category (represented by CATEGORY_*)
string	$pExcelName	Excel function name
string	$pPHPExcelName	PHPExcel function mapping

Exceptions

PHPExcel_Calculation_Exception

Definition at line 79 of file Function.php.

    {
        if (($pCategory !== NULL) && ($pExcelName !== NULL) && ($pPHPExcelName !== NULL)) {
                // Initialise values
                $this->_category                = $pCategory;
                $this->_excelName               = $pExcelName;
                $this->_phpExcelName    = $pPHPExcelName;
        } else {
                throw new PHPExcel_Calculation_Exception("Invalid parameters passed.");
        }
    }

Member Function Documentation

getCategory()

PHPExcel_Calculation_Function::getCategory

(

)

Get Category (represented by CATEGORY_*)

Returns

string

Definition at line 96 of file Function.php.

                                  {
        return $this->_category;
    }

References $_category.

getExcelName()

PHPExcel_Calculation_Function::getExcelName

(

)

Get Excel name.

Returns

string

Definition at line 119 of file Function.php.

                                   {
        return $this->_excelName;
    }

References $_excelName.

getPHPExcelName()

PHPExcel_Calculation_Function::getPHPExcelName

(

)

Get PHPExcel name.

Returns

string

Definition at line 137 of file Function.php.

                                      {
        return $this->_phpExcelName;
    }

References $_phpExcelName.

setCategory()

PHPExcel_Calculation_Function::setCategory

(

$value = null

)

Set Category (represented by CATEGORY_*)

Parameters

string

$value

Exceptions

PHPExcel_Calculation_Exception

Definition at line 106 of file Function.php.

                                               {
        if (!is_null($value)) {
                $this->_category = $value;
        } else {
                throw new PHPExcel_Calculation_Exception("Invalid parameter passed.");
        }
    }

setExcelName()

PHPExcel_Calculation_Function::setExcelName

(

$value

)

Set Excel name.

Parameters

string

$value

Definition at line 128 of file Function.php.

                                         {
        $this->_excelName = $value;
    }

setPHPExcelName()

PHPExcel_Calculation_Function::setPHPExcelName

(

$value

)

Set PHPExcel name.

Parameters

string

$value

Definition at line 146 of file Function.php.

                                            {
        $this->_phpExcelName = $value;
    }

Field Documentation

$_category

PHPExcel_Calculation_Function::$_category

private

Definition at line 55 of file Function.php.

Referenced by getCategory().

$_excelName

PHPExcel_Calculation_Function::$_excelName

private

Definition at line 62 of file Function.php.

Referenced by getExcelName().

$_phpExcelName

PHPExcel_Calculation_Function::$_phpExcelName

private

Definition at line 69 of file Function.php.

Referenced by getPHPExcelName().

CATEGORY_CUBE

const PHPExcel_Calculation_Function::CATEGORY_CUBE = 'Cube'

Definition at line 38 of file Function.php.

CATEGORY_DATABASE

const PHPExcel_Calculation_Function::CATEGORY_DATABASE = 'Database'

Definition at line 39 of file Function.php.

CATEGORY_DATE_AND_TIME

const PHPExcel_Calculation_Function::CATEGORY_DATE_AND_TIME = 'Date and Time'

Definition at line 40 of file Function.php.

CATEGORY_ENGINEERING

const PHPExcel_Calculation_Function::CATEGORY_ENGINEERING = 'Engineering'

Definition at line 41 of file Function.php.

CATEGORY_FINANCIAL

const PHPExcel_Calculation_Function::CATEGORY_FINANCIAL = 'Financial'

Definition at line 42 of file Function.php.

CATEGORY_INFORMATION

const PHPExcel_Calculation_Function::CATEGORY_INFORMATION = 'Information'

Definition at line 43 of file Function.php.

CATEGORY_LOGICAL

const PHPExcel_Calculation_Function::CATEGORY_LOGICAL = 'Logical'

Definition at line 44 of file Function.php.

CATEGORY_LOOKUP_AND_REFERENCE

const PHPExcel_Calculation_Function::CATEGORY_LOOKUP_AND_REFERENCE = 'Lookup and Reference'

Definition at line 45 of file Function.php.

CATEGORY_MATH_AND_TRIG

const PHPExcel_Calculation_Function::CATEGORY_MATH_AND_TRIG = 'Math and Trig'

Definition at line 46 of file Function.php.

CATEGORY_STATISTICAL

const PHPExcel_Calculation_Function::CATEGORY_STATISTICAL = 'Statistical'

Definition at line 47 of file Function.php.

CATEGORY_TEXT_AND_DATA

const PHPExcel_Calculation_Function::CATEGORY_TEXT_AND_DATA = 'Text and Data'

Definition at line 48 of file Function.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Calculation/Function.php