\PHPExcel

hasMacros()

hasMacros() : true

The workbook has macros ?

Returns

if workbook has macros, false if not

setHasMacros()

setHasMacros(  $hasMacros = false) 

Define if a workbook has macros

Parameters

setMacrosCode()

setMacrosCode(  $MacrosCode) 

Set the macros code

Parameters

getMacrosCode()

getMacrosCode() : \binary|null

Return the macros code

Returns

setMacrosCertificate()

setMacrosCertificate(  $Certificate = NULL) 

Set the macros certificate

Parameters

hasMacrosCertificate()

hasMacrosCertificate() : true|false

Is the project signed ?

Returns

getMacrosCertificate()

getMacrosCertificate() : \binary|null

Return the macros certificate

Returns

discardMacros()

discardMacros() : void

Remove all macros, certificate from spreadsheet

setRibbonXMLData()

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

set ribbon XML data

Parameters

getRibbonXMLData()

getRibbonXMLData(  $What = 'all') 

retrieve ribbon XML Data

return string|null|array

Parameters

setRibbonBinObjects()

setRibbonBinObjects(  $BinObjectsNames = NULL,   $BinObjectsData = NULL) 

store binaries ribbon objects (pictures)

Parameters

getRibbonBinObjects()

getRibbonBinObjects(  $What = 'all') 

retrieve Binaries Ribbon Objects

Parameters

hasRibbon()

hasRibbon() : true|false

This workbook have a custom UI ?

Returns

hasRibbonBinObjects()

hasRibbonBinObjects() : true|false

This workbook have additionnal object for the ribbon ?

Returns

sheetCodeNameExists()

sheetCodeNameExists(string  $pSheetCodeName) : boolean

Check if a sheet with a specified code name already exists

Parameters

Returns

getSheetByCodeName()

getSheetByCodeName(string  $pName = '') : \PHPExcel_Worksheet

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

Parameters

Returns

__construct()

__construct() 

Create a new PHPExcel with one Worksheet

__destruct()

__destruct() 

Code to execute when this worksheet is unset()

disconnectWorksheets()

disconnectWorksheets() 

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

getCalculationEngine()

getCalculationEngine() : \PHPExcel_Calculation

Return the calculation engine for this worksheet

Returns

getProperties()

getProperties() : \PHPExcel_DocumentProperties

Get properties

Returns

setProperties()

setProperties(\PHPExcel_DocumentProperties  $pValue) 

Set properties

Parameters

getSecurity()

getSecurity() : \PHPExcel_DocumentSecurity

Get security

Returns

setSecurity()

setSecurity(\PHPExcel_DocumentSecurity  $pValue) 

Set security

Parameters

getActiveSheet()

getActiveSheet() : \PHPExcel_Worksheet

Get active sheet

Throws

\PHPExcel_Exception

Returns

createSheet()

createSheet(integer|null  $iSheetIndex = NULL) : \PHPExcel_Worksheet

Create sheet and add it to this workbook

Parameters

Throws

\PHPExcel_Exception

Returns

sheetNameExists()

sheetNameExists(string  $pSheetName) : boolean

Check if a sheet with a specified name already exists

Parameters

Returns

addSheet()

addSheet(\PHPExcel_Worksheet  $pSheet, integer|null  $iSheetIndex = NULL) : \PHPExcel_Worksheet

Add sheet

Parameters

Throws

\PHPExcel_Exception

Returns

removeSheetByIndex()

removeSheetByIndex(integer  $pIndex) 

Remove sheet by index

Parameters

Throws

\PHPExcel_Exception

getSheet()

getSheet(integer  $pIndex) : \PHPExcel_Worksheet

Get sheet by index

Parameters

Throws

\PHPExcel_Exception

Returns

getAllSheets()

getAllSheets() : array<mixed,\PHPExcel_Worksheet>

Get all sheets

Returns

getSheetByName()

getSheetByName(string  $pName = '') : \PHPExcel_Worksheet

Get sheet by name

Parameters

Returns

getIndex()

getIndex(\PHPExcel_Worksheet  $pSheet) : \Sheet

Get index for sheet

Parameters

Throws

\PHPExcel_Exception

Returns

index

setIndexByName()

setIndexByName(string  $sheetName, integer  $newIndex) : \New

Set index for sheet by sheet name.

Parameters

Throws

\PHPExcel_Exception

Returns

sheet index

getSheetCount()

getSheetCount() : integer

Get sheet count

Returns

getActiveSheetIndex()

getActiveSheetIndex() : integer

Get active sheet index

Returns

Active sheet index

setActiveSheetIndex()

setActiveSheetIndex(integer  $pIndex) : \PHPExcel_Worksheet

Set active sheet index

Parameters

Throws

\PHPExcel_Exception

Returns

setActiveSheetIndexByName()

setActiveSheetIndexByName(string  $pValue = '') : \PHPExcel_Worksheet

Set active sheet index by name

Parameters

Throws

\PHPExcel_Exception

Returns

getSheetNames()

getSheetNames() : array<mixed,string>

Get sheet names

Returns

addExternalSheet()

addExternalSheet(\PHPExcel_Worksheet  $pSheet, integer|null  $iSheetIndex = null) : \PHPExcel_Worksheet

Add external sheet

Parameters

Throws

\PHPExcel_Exception

Returns

getNamedRanges()

getNamedRanges() : array<mixed,\PHPExcel_NamedRange>

Get named ranges

Returns

addNamedRange()

addNamedRange(\PHPExcel_NamedRange  $namedRange) : \PHPExcel

Add named range

Parameters

Returns

getNamedRange()

getNamedRange(string  $namedRange, \PHPExcel_Worksheet|null  $pSheet = null) : \PHPExcel_NamedRange|null

Get named range

Parameters

Returns

removeNamedRange()

removeNamedRange(string  $namedRange, \PHPExcel_Worksheet|null  $pSheet = null) : \PHPExcel

Remove named range

Parameters

Returns

getWorksheetIterator()

getWorksheetIterator() : \PHPExcel_WorksheetIterator

Get worksheet iterator

Returns

copy()

copy() : \PHPExcel

Copy workbook (!= clone!)

Returns

__clone()

__clone() 

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

getCellXfCollection()

getCellXfCollection() : array<mixed,\PHPExcel_Style>

Get the workbook collection of cellXfs

Returns

getCellXfByIndex()

getCellXfByIndex(integer  $pIndex) : \PHPExcel_Style

Get cellXf by index

Parameters

Returns

getCellXfByHashCode()

getCellXfByHashCode(string  $pValue = '') : \PHPExcel_Style|false

Get cellXf by hash code

Parameters

Returns

cellXfExists()

cellXfExists(\PHPExcel_Style  $pCellStyle = null) : boolean

Check if style exists in style collection

Parameters

Returns

getDefaultStyle()

getDefaultStyle() : \PHPExcel_Style

Get default style

Throws

\PHPExcel_Exception

Returns

addCellXf()

addCellXf(\PHPExcel_Style  $style) 

Add a cellXf to the workbook

Parameters

removeCellXfByIndex()

removeCellXfByIndex(integer  $pIndex) 

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

Parameters

Throws

\PHPExcel_Exception

getCellXfSupervisor()

getCellXfSupervisor() : \PHPExcel_Style

Get the cellXf supervisor

Returns

getCellStyleXfCollection()

getCellStyleXfCollection() : array<mixed,\PHPExcel_Style>

Get the workbook collection of cellStyleXfs

Returns

getCellStyleXfByIndex()

getCellStyleXfByIndex(integer  $pIndex) : \PHPExcel_Style

Get cellStyleXf by index

Parameters

Returns

getCellStyleXfByHashCode()

getCellStyleXfByHashCode(string  $pValue = '') : \PHPExcel_Style|false

Get cellStyleXf by hash code

Parameters

Returns

addCellStyleXf()

addCellStyleXf(\PHPExcel_Style  $pStyle) 

Add a cellStyleXf to the workbook

Parameters

removeCellStyleXfByIndex()

removeCellStyleXfByIndex(integer  $pIndex) 

Remove cellStyleXf by index

Parameters

Throws

\PHPExcel_Exception

garbageCollect()

garbageCollect() 

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

getID()

getID() : string

Return the unique ID value assigned to this spreadsheet workbook

Returns

_getExtensionOnly()

_getExtensionOnly(  $ThePath) 

return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function)

Parameters