BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
PHPExcel Class Reference

Public Member Functions

 hasMacros ()
 
 setHasMacros ($hasMacros=false)
 
 setMacrosCode ($MacrosCode)
 
 getMacrosCode ()
 
 setMacrosCertificate ($Certificate=NULL)
 
 hasMacrosCertificate ()
 
 getMacrosCertificate ()
 
 discardMacros ()
 
 setRibbonXMLData ($Target=NULL, $XMLData=NULL)
 
 getRibbonXMLData ($What='all')
 
 setRibbonBinObjects ($BinObjectsNames=NULL, $BinObjectsData=NULL)
 
 getRibbonBinObjects ($What='all')
 
 hasRibbon ()
 
 hasRibbonBinObjects ()
 
 sheetCodeNameExists ($pSheetCodeName)
 
 getSheetByCodeName ($pName= '')
 
 __construct ()
 
 __destruct ()
 
 disconnectWorksheets ()
 
 getCalculationEngine ()
 
 getProperties ()
 
 setProperties (PHPExcel_DocumentProperties $pValue)
 
 getSecurity ()
 
 setSecurity (PHPExcel_DocumentSecurity $pValue)
 
 getActiveSheet ()
 
 createSheet ($iSheetIndex=NULL)
 
 sheetNameExists ($pSheetName)
 
 addSheet (PHPExcel_Worksheet $pSheet, $iSheetIndex=NULL)
 
 removeSheetByIndex ($pIndex=0)
 
 getSheet ($pIndex=0)
 
 getAllSheets ()
 
 getSheetByName ($pName= '')
 
 getIndex (PHPExcel_Worksheet $pSheet)
 
 setIndexByName ($sheetName, $newIndex)
 
 getSheetCount ()
 
 getActiveSheetIndex ()
 
 setActiveSheetIndex ($pIndex=0)
 
 setActiveSheetIndexByName ($pValue= '')
 
 getSheetNames ()
 
 addExternalSheet (PHPExcel_Worksheet $pSheet, $iSheetIndex=null)
 
 getNamedRanges ()
 
 addNamedRange (PHPExcel_NamedRange $namedRange)
 
 getNamedRange ($namedRange, PHPExcel_Worksheet $pSheet=null)
 
 removeNamedRange ($namedRange, PHPExcel_Worksheet $pSheet=null)
 
 getWorksheetIterator ()
 
 copy ()
 
 __clone ()
 
 getCellXfCollection ()
 
 getCellXfByIndex ($pIndex=0)
 
 getCellXfByHashCode ($pValue= '')
 
 cellXfExists ($pCellStyle=null)
 
 getDefaultStyle ()
 
 addCellXf (PHPExcel_Style $style)
 
 removeCellXfByIndex ($pIndex=0)
 
 getCellXfSupervisor ()
 
 getCellStyleXfCollection ()
 
 getCellStyleXfByIndex ($pIndex=0)
 
 getCellStyleXfByHashCode ($pValue= '')
 
 addCellStyleXf (PHPExcel_Style $pStyle)
 
 removeCellStyleXfByIndex ($pIndex=0)
 
 garbageCollect ()
 
 getID ()
 

Constructor & Destructor Documentation

PHPExcel::__construct ( )

Create a new PHPExcel with one Worksheet

PHPExcel::__destruct ( )

Code to execute when this worksheet is unset()

Member Function Documentation

PHPExcel::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

PHPExcel::addCellStyleXf ( PHPExcel_Style  $pStyle)

Add a cellStyleXf to the workbook

Parameters
PHPExcel_Style$pStyle
PHPExcel::addCellXf ( PHPExcel_Style  $style)

Add a cellXf to the workbook

Parameters
PHPExcel_Style$style
PHPExcel::addExternalSheet ( PHPExcel_Worksheet  $pSheet,
  $iSheetIndex = null 
)

Add external sheet

Parameters
PHPExcel_Worksheet$pSheetExternal sheet to add
int | null$iSheetIndexIndex where sheet should go (0,1,..., or null for last)
Exceptions
PHPExcel_Exception
Returns
PHPExcel_Worksheet
PHPExcel::addNamedRange ( PHPExcel_NamedRange  $namedRange)

Add named range

Parameters
PHPExcel_NamedRange$namedRange
Returns
PHPExcel
PHPExcel::addSheet ( PHPExcel_Worksheet  $pSheet,
  $iSheetIndex = NULL 
)

Add sheet

Parameters
PHPExcel_Worksheet$pSheet
int | null$iSheetIndexIndex where sheet should go (0,1,..., or null for last)
Returns
PHPExcel_Worksheet
Exceptions
PHPExcel_Exception
PHPExcel::cellXfExists (   $pCellStyle = null)

Check if style exists in style collection

Parameters
PHPExcel_Style$pCellStyle
Returns
boolean
PHPExcel::copy ( )

Copy workbook (!= clone!)

Returns
PHPExcel
PHPExcel::createSheet (   $iSheetIndex = NULL)

Create sheet and add it to this workbook

Parameters
int | null$iSheetIndexIndex where sheet should go (0,1,..., or null for last)
Returns
PHPExcel_Worksheet
Exceptions
PHPExcel_Exception
PHPExcel::discardMacros ( )

Remove all macros, certificate from spreadsheet

Parameters
none
Returns
void
PHPExcel::disconnectWorksheets ( )

Disconnect all worksheets from this PHPExcel workbook object, typically so that the PHPExcel object can be unset

PHPExcel::garbageCollect ( )

Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells and columns in the workbook

PHPExcel::getActiveSheet ( )

Get active sheet

Returns
PHPExcel_Worksheet
PHPExcel::getActiveSheetIndex ( )

Get active sheet index

Returns
int Active sheet index
PHPExcel::getAllSheets ( )

Get all sheets

Returns
PHPExcel_Worksheet[]
PHPExcel::getCalculationEngine ( )

Return the calculation engine for this worksheet

Returns
PHPExcel_Calculation
PHPExcel::getCellStyleXfByHashCode (   $pValue = '')

Get cellStyleXf by hash code

Parameters
string$pValue
Returns
PHPExcel_Style|false
PHPExcel::getCellStyleXfByIndex (   $pIndex = 0)

Get cellStyleXf by index

Parameters
int$pIndex
Returns
PHPExcel_Style
PHPExcel::getCellStyleXfCollection ( )

Get the workbook collection of cellStyleXfs

Returns
PHPExcel_Style[]
PHPExcel::getCellXfByHashCode (   $pValue = '')

Get cellXf by hash code

Parameters
string$pValue
Returns
PHPExcel_Style|false
PHPExcel::getCellXfByIndex (   $pIndex = 0)

Get cellXf by index

Parameters
int$pIndex
Returns
PHPExcel_Style
PHPExcel::getCellXfCollection ( )

Get the workbook collection of cellXfs

Returns
PHPExcel_Style[]
PHPExcel::getCellXfSupervisor ( )

Get the cellXf supervisor

Returns
PHPExcel_Style
PHPExcel::getDefaultStyle ( )

Get default style

Returns
PHPExcel_Style
Exceptions
PHPExcel_Exception
PHPExcel::getID ( )

Return the unique ID value assigned to this spreadsheet workbook

Returns
string
PHPExcel::getIndex ( PHPExcel_Worksheet  $pSheet)

Get index for sheet

Parameters
PHPExcel_Worksheet$pSheet
Returns
Sheet index
Exceptions
PHPExcel_Exception
PHPExcel::getMacrosCertificate ( )

Return the macros certificate

Returns
binary|null
PHPExcel::getMacrosCode ( )

Return the macros code

Returns
binary|null
PHPExcel::getNamedRange (   $namedRange,
PHPExcel_Worksheet  $pSheet = null 
)

Get named range

Parameters
string$namedRange
PHPExcel_Worksheet | null$pSheetScope. Use null for global scope
Returns
PHPExcel_NamedRange|null
PHPExcel::getNamedRanges ( )

Get named ranges

Returns
PHPExcel_NamedRange[]
PHPExcel::getProperties ( )

Get properties

Returns
PHPExcel_DocumentProperties
PHPExcel::getRibbonBinObjects (   $What = 'all')

retrieve Binaries Ribbon Objects

PHPExcel::getRibbonXMLData (   $What = 'all')

retrieve ribbon XML Data

return string|null|array

PHPExcel::getSecurity ( )

Get security

Returns
PHPExcel_DocumentSecurity
PHPExcel::getSheet (   $pIndex = 0)

Get sheet by index

Parameters
int$pIndexSheet index
Returns
PHPExcel_Worksheet
Exceptions
PHPExcel_Exception
PHPExcel::getSheetByCodeName (   $pName = '')

Get sheet by code name. Warning : sheet don't have always a code name !

Parameters
string$pNameSheet name
Returns
PHPExcel_Worksheet
PHPExcel::getSheetByName (   $pName = '')

Get sheet by name

Parameters
string$pNameSheet name
Returns
PHPExcel_Worksheet
PHPExcel::getSheetCount ( )

Get sheet count

Returns
int
PHPExcel::getSheetNames ( )

Get sheet names

Returns
string[]
PHPExcel::getWorksheetIterator ( )

Get worksheet iterator

Returns
PHPExcel_WorksheetIterator
PHPExcel::hasMacros ( )

The workbook has macros ?

Returns
true if workbook has macros, false if not
PHPExcel::hasMacrosCertificate ( )

Is the project signed ?

Returns
true|false
PHPExcel::hasRibbon ( )

This workbook have a custom UI ?

Returns
true|false
PHPExcel::hasRibbonBinObjects ( )

This workbook have additionnal object for the ribbon ?

Returns
true|false
PHPExcel::removeCellStyleXfByIndex (   $pIndex = 0)

Remove cellStyleXf by index

Parameters
int$pIndex
Exceptions
PHPExcel_Exception
PHPExcel::removeCellXfByIndex (   $pIndex = 0)

Remove cellXf by index. It is ensured that all cells get their xf index updated.

Parameters
int$pIndexIndex to cellXf
Exceptions
PHPExcel_Exception
PHPExcel::removeNamedRange (   $namedRange,
PHPExcel_Worksheet  $pSheet = null 
)

Remove named range

Parameters
string$namedRange
PHPExcel_Worksheet | null$pSheetScope: use null for global scope.
Returns
PHPExcel
PHPExcel::removeSheetByIndex (   $pIndex = 0)

Remove sheet by index

Parameters
int$pIndexActive sheet index
Exceptions
PHPExcel_Exception
PHPExcel::setActiveSheetIndex (   $pIndex = 0)

Set active sheet index

Parameters
int$pIndexActive sheet index
Exceptions
PHPExcel_Exception
Returns
PHPExcel_Worksheet
PHPExcel::setActiveSheetIndexByName (   $pValue = '')

Set active sheet index by name

Parameters
string$pValueSheet title
Returns
PHPExcel_Worksheet
Exceptions
PHPExcel_Exception
PHPExcel::setHasMacros (   $hasMacros = false)

Define if a workbook has macros

Parameters
true|false
PHPExcel::setIndexByName (   $sheetName,
  $newIndex 
)

Set index for sheet by sheet name.

Parameters
string$sheetNameSheet name to modify index for
int$newIndexNew index for the sheet
Returns
New sheet index
Exceptions
PHPExcel_Exception
PHPExcel::setMacrosCertificate (   $Certificate = NULL)

Set the macros certificate

Parameters
binary|null
PHPExcel::setMacrosCode (   $MacrosCode)

Set the macros code

Parameters
binarystring|null
PHPExcel::setProperties ( PHPExcel_DocumentProperties  $pValue)

Set properties

Parameters
PHPExcel_DocumentProperties$pValue
PHPExcel::setRibbonBinObjects (   $BinObjectsNames = NULL,
  $BinObjectsData = NULL 
)

store binaries ribbon objects (pictures)

PHPExcel::setRibbonXMLData (   $Target = NULL,
  $XMLData = NULL 
)

set ribbon XML data

PHPExcel::setSecurity ( PHPExcel_DocumentSecurity  $pValue)

Set security

Parameters
PHPExcel_DocumentSecurity$pValue
PHPExcel::sheetCodeNameExists (   $pSheetCodeName)

Check if a sheet with a specified code name already exists

Parameters
string$pSheetCodeNameName of the worksheet to check
Returns
boolean
PHPExcel::sheetNameExists (   $pSheetName)

Check if a sheet with a specified name already exists

Parameters
string$pSheetNameName of the worksheet to check
Returns
boolean

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