Class PHPExcel

PHPExcel

Package: PHPExcel
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel.php

Methods summary
`public true`	# `hasMacros( )` The workbook has macros ? The workbook has macros ? Returns true if workbook has macros, false if not
`public`	# `setHasMacros( true\|false $hasMacros = false )` Define if a workbook has macros Define if a workbook has macros Parameters `$hasMacros`
`public`	# `setMacrosCode( binary $MacrosCode )` Set the macros code Set the macros code Parameters `$MacrosCode` string\|null
`public binary\|null`	# `getMacrosCode( )` Return the macros code Return the macros code Returns binary\|null
`public`	# `setMacrosCertificate( binary\|null $Certificate = NULL )` Set the macros certificate Set the macros certificate Parameters `$Certificate`
`public true\|false`	# `hasMacrosCertificate( )` Is the project signed ? Is the project signed ? Returns true\|false
`public binary\|null`	# `getMacrosCertificate( )` Return the macros certificate Return the macros certificate Returns binary\|null
`public`	# `discardMacros( )` Remove all macros, certificate from spreadsheet Remove all macros, certificate from spreadsheet
`public`	# `setRibbonXMLData( $Target = NULL, $XMLData = NULL )` set ribbon XML data set ribbon XML data
`public`	# `getRibbonXMLData( $What = 'all' )` retrieve ribbon XML Data retrieve ribbon XML Data return string\|null\|array
`public`	# `setRibbonBinObjects( $BinObjectsNames = NULL, $BinObjectsData = NULL )` store binaries ribbon objects (pictures) store binaries ribbon objects (pictures)
`private`	# `_getExtensionOnly( $ThePath )` return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function) return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function)
`public`	# `getRibbonBinObjects( $What = 'all' )` retrieve Binaries Ribbon Objects retrieve Binaries Ribbon Objects
`public true\|false`	# `hasRibbon( )` This workbook have a custom UI ? This workbook have a custom UI ? Returns true\|false
`public true\|false`	# `hasRibbonBinObjects( )` This workbook have additionnal object for the ribbon ? This workbook have additionnal object for the ribbon ? Returns true\|false
`public boolean`	# `sheetCodeNameExists( string $pSheetCodeName )` Check if a sheet with a specified code name already exists Check if a sheet with a specified code name already exists Parameters `$pSheetCodeName` Name of the worksheet to check Returns boolean
`public PHPExcel_Worksheet`	# `getSheetByCodeName( string $pName = '' )` Get sheet by code name. Warning : sheet don't have always a code name ! Get sheet by code name. Warning : sheet don't have always a code name ! Parameters `$pName` Sheet name Returns `PHPExcel_Worksheet`
`public`	# `__construct( )` Create a new PHPExcel with one Worksheet Create a new PHPExcel with one Worksheet
`public`	# `__destruct( )` Code to execute when this worksheet is unset() Code to execute when this worksheet is unset()
`public`	# `disconnectWorksheets( )` Disconnect all worksheets from this PHPExcel workbook object, typically so that the PHPExcel object can be unset Disconnect all worksheets from this PHPExcel workbook object, typically so that the PHPExcel object can be unset
`public PHPExcel_Calculation`	# `getCalculationEngine( )` Return the calculation engine for this worksheet Return the calculation engine for this worksheet Returns `PHPExcel_Calculation`
`public PHPExcel_DocumentProperties`	# `getProperties( )` Get properties Get properties Returns `PHPExcel_DocumentProperties`
`public`	# `setProperties( PHPExcel_DocumentProperties $pValue )` Set properties Set properties Parameters `$pValue`
`public PHPExcel_DocumentSecurity`	# `getSecurity( )` Get security Get security Returns `PHPExcel_DocumentSecurity`
`public`	# `setSecurity( PHPExcel_DocumentSecurity $pValue )` Set security Set security Parameters `$pValue`
`public PHPExcel_Worksheet`	# `getActiveSheet( )` Get active sheet Get active sheet Returns `PHPExcel_Worksheet`
`public PHPExcel_Worksheet`	# `createSheet( integer\|null $iSheetIndex = NULL )` Create sheet and add it to this workbook Create sheet and add it to this workbook Parameters `$iSheetIndex` Index where sheet should go (0,1,..., or null for last) Returns `PHPExcel_Worksheet` Throws `PHPExcel_Exception`
`public boolean`	# `sheetNameExists( string $pSheetName )` Check if a sheet with a specified name already exists Check if a sheet with a specified name already exists Parameters `$pSheetName` Name of the worksheet to check Returns boolean
`public PHPExcel_Worksheet`	# `addSheet( PHPExcel_Worksheet $pSheet, integer\|null $iSheetIndex = NULL )` Add sheet Add sheet Parameters `$pSheet` `$iSheetIndex` Index where sheet should go (0,1,..., or null for last) Returns `PHPExcel_Worksheet` Throws `PHPExcel_Exception`
`public`	# `removeSheetByIndex( integer $pIndex = 0 )` Remove sheet by index Remove sheet by index Parameters `$pIndex` Active sheet index Throws `PHPExcel_Exception`
`public PHPExcel_Worksheet`	# `getSheet( integer $pIndex = 0 )` Get sheet by index Get sheet by index Parameters `$pIndex` Sheet index Returns `PHPExcel_Worksheet` Throws `PHPExcel_Exception`
`public PHPExcel_Worksheet[]`	# `getAllSheets( )` Get all sheets Get all sheets Returns `PHPExcel_Worksheet[]`
`public PHPExcel_Worksheet`	# `getSheetByName( string $pName = '' )` Get sheet by name Get sheet by name Parameters `$pName` Sheet name Returns `PHPExcel_Worksheet`
`public Sheet`	# `getIndex( PHPExcel_Worksheet $pSheet )` Get index for sheet Get index for sheet Parameters `$pSheet` Returns Sheet index Throws `PHPExcel_Exception`
`public New`	# `setIndexByName( string $sheetName, integer $newIndex )` Set index for sheet by sheet name. Set index for sheet by sheet name. Parameters `$sheetName` Sheet name to modify index for `$newIndex` New index for the sheet Returns New sheet index Throws `PHPExcel_Exception`
`public integer`	# `getSheetCount( )` Get sheet count Get sheet count Returns integer
`public integer`	# `getActiveSheetIndex( )` Get active sheet index Get active sheet index Returns integer Active sheet index
`public PHPExcel_Worksheet`	# `setActiveSheetIndex( integer $pIndex = 0 )` Set active sheet index Set active sheet index Parameters `$pIndex` Active sheet index Returns `PHPExcel_Worksheet` Throws `PHPExcel_Exception`
`public PHPExcel_Worksheet`	# `setActiveSheetIndexByName( string $pValue = '' )` Set active sheet index by name Set active sheet index by name Parameters `$pValue` Sheet title Returns `PHPExcel_Worksheet` Throws `PHPExcel_Exception`
`public string[]`	# `getSheetNames( )` Get sheet names Get sheet names Returns string[]
`public PHPExcel_Worksheet`	# `addExternalSheet( PHPExcel_Worksheet $pSheet, integer\|null $iSheetIndex = null )` Add external sheet Add external sheet Parameters `$pSheet` External sheet to add `$iSheetIndex` Index where sheet should go (0,1,..., or null for last) Returns `PHPExcel_Worksheet` Throws `PHPExcel_Exception`
`public PHPExcel_NamedRange[]`	# `getNamedRanges( )` Get named ranges Get named ranges Returns `PHPExcel_NamedRange[]`
`public PHPExcel`	# `addNamedRange( PHPExcel_NamedRange $namedRange )` Add named range Add named range Parameters `$namedRange` Returns `PHPExcel`
`public PHPExcel_NamedRange\|null`	# `getNamedRange( string $namedRange, PHPExcel_Worksheet $pSheet = null )` Get named range Get named range Parameters `$namedRange` `$pSheet` Scope. Use null for global scope Returns `PHPExcel_NamedRange`\|null
`public PHPExcel`	# `removeNamedRange( string $namedRange, PHPExcel_Worksheet $pSheet = null )` Remove named range Remove named range Parameters `$namedRange` `$pSheet` Scope: use null for global scope. Returns `PHPExcel`
`public PHPExcel_WorksheetIterator`	# `getWorksheetIterator( )` Get worksheet iterator Get worksheet iterator Returns `PHPExcel_WorksheetIterator`
`public PHPExcel`	# `copy( )` Copy workbook (!= clone!) Copy workbook (!= clone!) Returns `PHPExcel`
`public`	# `__clone( )` Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy.
`public PHPExcel_Style[]`	# `getCellXfCollection( )` Get the workbook collection of cellXfs Get the workbook collection of cellXfs Returns `PHPExcel_Style[]`
`public PHPExcel_Style`	# `getCellXfByIndex( integer $pIndex = 0 )` Get cellXf by index Get cellXf by index Parameters `$pIndex` Returns `PHPExcel_Style`
`public PHPExcel_Style\|false`	# `getCellXfByHashCode( string $pValue = '' )` Get cellXf by hash code Get cellXf by hash code Parameters `$pValue` Returns `PHPExcel_Style`\|false
`public boolean`	# `cellXfExists( PHPExcel_Style $pCellStyle = null )` Check if style exists in style collection Check if style exists in style collection Parameters `$pCellStyle` Returns boolean
`public PHPExcel_Style`	# `getDefaultStyle( )` Get default style Get default style Returns `PHPExcel_Style` Throws `PHPExcel_Exception`
`public`	# `addCellXf( PHPExcel_Style $style )` Add a cellXf to the workbook Add a cellXf to the workbook Parameters `$style`
`public`	# `removeCellXfByIndex( integer $pIndex = 0 )` Remove cellXf by index. It is ensured that all cells get their xf index updated. Remove cellXf by index. It is ensured that all cells get their xf index updated. Parameters `$pIndex` Index to cellXf Throws `PHPExcel_Exception`
`public PHPExcel_Style`	# `getCellXfSupervisor( )` Get the cellXf supervisor Get the cellXf supervisor Returns `PHPExcel_Style`
`public PHPExcel_Style[]`	# `getCellStyleXfCollection( )` Get the workbook collection of cellStyleXfs Get the workbook collection of cellStyleXfs Returns `PHPExcel_Style[]`
`public PHPExcel_Style`	# `getCellStyleXfByIndex( integer $pIndex = 0 )` Get cellStyleXf by index Get cellStyleXf by index Parameters `$pIndex` Returns `PHPExcel_Style`
`public PHPExcel_Style\|false`	# `getCellStyleXfByHashCode( string $pValue = '' )` Get cellStyleXf by hash code Get cellStyleXf by hash code Parameters `$pValue` Returns `PHPExcel_Style`\|false
`public`	# `addCellStyleXf( PHPExcel_Style $pStyle )` Add a cellStyleXf to the workbook Add a cellStyleXf to the workbook Parameters `$pStyle`
`public`	# `removeCellStyleXfByIndex( integer $pIndex = 0 )` Remove cellStyleXf by index Remove cellStyleXf by index Parameters `$pIndex` Throws `PHPExcel_Exception`
`public`	# `garbageCollect( )` Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells and columns in the workbook Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells and columns in the workbook
`public string`	# `getID( )` Return the unique ID value assigned to this spreadsheet workbook Return the unique ID value assigned to this spreadsheet workbook Returns string

Properties summary
`private string`	`$_uniqueID` Unique ID Unique ID	#
`private PHPExcel_DocumentProperties`	`$_properties` Document properties Document properties	#
`private PHPExcel_DocumentSecurity`	`$_security` Document security Document security	#
`private PHPExcel_Worksheet[]`	`$_workSheetCollection` Collection of Worksheet objects Collection of Worksheet objects	# `array()`
`private PHPExcel_Calculation`	`$_calculationEngine` Calculation Engine Calculation Engine	# `NULL`
`private integer`	`$_activeSheetIndex` Active sheet index Active sheet index	# `0`
`private PHPExcel_NamedRange[]`	`$_namedRanges` Named ranges Named ranges	# `array()`
`private PHPExcel_Style`	`$_cellXfSupervisor` CellXf supervisor CellXf supervisor	#
`private PHPExcel_Style[]`	`$_cellXfCollection` CellXf collection CellXf collection	# `array()`
`private PHPExcel_Style[]`	`$_cellStyleXfCollection` CellStyleXf collection CellStyleXf collection	# `array()`
`private boolean`	`$_hasMacros` _hasMacros : this workbook have macros ? _hasMacros : this workbook have macros ?	# `FALSE`
`private binary`	`$_macrosCode` _macrosCode : all macros code (the vbaProject.bin file, this include form, code, etc.), NULL if no macro _macrosCode : all macros code (the vbaProject.bin file, this include form, code, etc.), NULL if no macro	# `NULL`
`private binary`	`$_macrosCertificate` _macrosCertificate : if macros are signed, contains vbaProjectSignature.bin file, NULL if not signed _macrosCertificate : if macros are signed, contains vbaProjectSignature.bin file, NULL if not signed	# `NULL`
`private null\|string`	`$_ribbonXMLData` _ribbonXMLData : NULL if workbook is'nt Excel 2007 or not contain a customized UI _ribbonXMLData : NULL if workbook is'nt Excel 2007 or not contain a customized UI	# `NULL`
`private null\|array`	`$_ribbonBinObjects` _ribbonBinObjects : NULL if workbook is'nt Excel 2007 or not contain embedded objects (picture(s)) for Ribbon Elements ignored if $_ribbonXMLData is null _ribbonBinObjects : NULL if workbook is'nt Excel 2007 or not contain embedded objects (picture(s)) for Ribbon Elements ignored if $_ribbonXMLData is null	# `NULL`

Packages

Classes

Interfaces

Exceptions

Class PHPExcel

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws

Parameters

Parameters

Throws

Returns