[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/phpexcel/ -> PHPExcel.php (summary)

(no description)

File Size: 1152 lines (31 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 lib/phpexcel/PHPExcel/Autoloader.php

Defines 1 class

PHPExcel:: (63 methods):
  hasMacros()
  setHasMacros()
  setMacrosCode()
  getMacrosCode()
  setMacrosCertificate()
  hasMacrosCertificate()
  getMacrosCertificate()
  discardMacros()
  setRibbonXMLData()
  getRibbonXMLData()
  setRibbonBinObjects()
  getExtensionOnly()
  getRibbonBinObjects()
  hasRibbon()
  hasRibbonBinObjects()
  sheetCodeNameExists()
  getSheetByCodeName()
  __construct()
  __destruct()
  disconnectWorksheets()
  getCalculationEngine()
  getProperties()
  setProperties()
  getSecurity()
  setSecurity()
  getActiveSheet()
  createSheet()
  sheetNameExists()
  addSheet()
  removeSheetByIndex()
  getSheet()
  getAllSheets()
  getSheetByName()
  getIndex()
  setIndexByName()
  getSheetCount()
  getActiveSheetIndex()
  setActiveSheetIndex()
  setActiveSheetIndexByName()
  getSheetNames()
  addExternalSheet()
  getNamedRanges()
  addNamedRange()
  getNamedRange()
  removeNamedRange()
  getWorksheetIterator()
  copy()
  __clone()
  getCellXfCollection()
  getCellXfByIndex()
  getCellXfByHashCode()
  cellXfExists()
  getDefaultStyle()
  addCellXf()
  removeCellXfByIndex()
  getCellXfSupervisor()
  getCellStyleXfCollection()
  getCellStyleXfByIndex()
  getCellStyleXfByHashCode()
  addCellStyleXf()
  removeCellStyleXfByIndex()
  garbageCollect()
  getID()


Class: PHPExcel  - X-Ref

PHPExcel

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

hasMacros()   X-Ref
The workbook has macros ?

return: true if workbook has macros, false if not

setHasMacros($hasMacros = false)   X-Ref
Define if a workbook has macros

param: boolean $hasMacros true|false

setMacrosCode($MacrosCode = null)   X-Ref
Set the macros code

param: string $MacrosCode string|null

getMacrosCode()   X-Ref
Return the macros code

return: string|null

setMacrosCertificate($Certificate = null)   X-Ref
Set the macros certificate

param: string|null $Certificate

hasMacrosCertificate()   X-Ref
Is the project signed ?

return: boolean true|false

getMacrosCertificate()   X-Ref
Return the macros certificate

return: string|null

discardMacros()   X-Ref
Remove all macros, certificate from spreadsheet


setRibbonXMLData($Target = null, $XMLData = null)   X-Ref
set ribbon XML data


getRibbonXMLData($What = 'all')   X-Ref
retrieve ribbon XML Data

return string|null|array

setRibbonBinObjects($BinObjectsNames = null, $BinObjectsData = null)   X-Ref
store binaries ribbon objects (pictures)


getExtensionOnly($ThePath)   X-Ref
return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function)


getRibbonBinObjects($What = 'all')   X-Ref
retrieve Binaries Ribbon Objects


hasRibbon()   X-Ref
This workbook have a custom UI ?

return: true|false

hasRibbonBinObjects()   X-Ref
This workbook have additionnal object for the ribbon ?

return: true|false

sheetCodeNameExists($pSheetCodeName)   X-Ref
Check if a sheet with a specified code name already exists

param: string $pSheetCodeName  Name of the worksheet to check
return: boolean

getSheetByCodeName($pName = '')   X-Ref
Get sheet by code name. Warning : sheet don't have always a code name !

param: string $pName Sheet name
return: PHPExcel_Worksheet

__construct()   X-Ref
Create a new PHPExcel with one Worksheet


__destruct()   X-Ref
Code to execute when this worksheet is unset()


disconnectWorksheets()   X-Ref
Disconnect all worksheets from this PHPExcel workbook object,
typically so that the PHPExcel object can be unset


getCalculationEngine()   X-Ref
Return the calculation engine for this worksheet

return: PHPExcel_Calculation

getProperties()   X-Ref
Get properties

return: PHPExcel_DocumentProperties

setProperties(PHPExcel_DocumentProperties $pValue)   X-Ref
Set properties

param: PHPExcel_DocumentProperties    $pValue

getSecurity()   X-Ref
Get security

return: PHPExcel_DocumentSecurity

setSecurity(PHPExcel_DocumentSecurity $pValue)   X-Ref
Set security

param: PHPExcel_DocumentSecurity    $pValue

getActiveSheet()   X-Ref
Get active sheet

return: PHPExcel_Worksheet

createSheet($iSheetIndex = null)   X-Ref
Create sheet and add it to this workbook

param: int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last)
return: PHPExcel_Worksheet

sheetNameExists($pSheetName)   X-Ref
Check if a sheet with a specified name already exists

param: string $pSheetName  Name of the worksheet to check
return: boolean

addSheet(PHPExcel_Worksheet $pSheet, $iSheetIndex = null)   X-Ref
Add sheet

param: PHPExcel_Worksheet $pSheet
param: int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last)
return: PHPExcel_Worksheet

removeSheetByIndex($pIndex = 0)   X-Ref
Remove sheet by index

param: int $pIndex Active sheet index

getSheet($pIndex = 0)   X-Ref
Get sheet by index

param: int $pIndex Sheet index
return: PHPExcel_Worksheet

getAllSheets()   X-Ref
Get all sheets

return: PHPExcel_Worksheet[]

getSheetByName($pName = '')   X-Ref
Get sheet by name

param: string $pName Sheet name
return: PHPExcel_Worksheet

getIndex(PHPExcel_Worksheet $pSheet)   X-Ref
Get index for sheet

param: PHPExcel_Worksheet $pSheet
return: Sheet index

setIndexByName($sheetName, $newIndex)   X-Ref
Set index for sheet by sheet name.

param: string $sheetName Sheet name to modify index for
param: int $newIndex New index for the sheet
return: New sheet index

getSheetCount()   X-Ref
Get sheet count

return: int

getActiveSheetIndex()   X-Ref
Get active sheet index

return: int Active sheet index

setActiveSheetIndex($pIndex = 0)   X-Ref
Set active sheet index

param: int $pIndex Active sheet index
return: PHPExcel_Worksheet

setActiveSheetIndexByName($pValue = '')   X-Ref
Set active sheet index by name

param: string $pValue Sheet title
return: PHPExcel_Worksheet

getSheetNames()   X-Ref
Get sheet names

return: string[]

addExternalSheet(PHPExcel_Worksheet $pSheet, $iSheetIndex = null)   X-Ref
Add external sheet

param: PHPExcel_Worksheet $pSheet External sheet to add
param: int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last)
return: PHPExcel_Worksheet

getNamedRanges()   X-Ref
Get named ranges

return: PHPExcel_NamedRange[]

addNamedRange(PHPExcel_NamedRange $namedRange)   X-Ref
Add named range

param: PHPExcel_NamedRange $namedRange
return: PHPExcel

getNamedRange($namedRange, PHPExcel_Worksheet $pSheet = null)   X-Ref
Get named range

param: string $namedRange
param: PHPExcel_Worksheet|null $pSheet Scope. Use null for global scope
return: PHPExcel_NamedRange|null

removeNamedRange($namedRange, PHPExcel_Worksheet $pSheet = null)   X-Ref
Remove named range

param: string  $namedRange
param: PHPExcel_Worksheet|null  $pSheet  Scope: use null for global scope.
return: PHPExcel

getWorksheetIterator()   X-Ref
Get worksheet iterator

return: PHPExcel_WorksheetIterator

copy()   X-Ref
Copy workbook (!= clone!)

return: PHPExcel

__clone()   X-Ref
Implement PHP __clone to create a deep clone, not just a shallow copy.


getCellXfCollection()   X-Ref
Get the workbook collection of cellXfs

return: PHPExcel_Style[]

getCellXfByIndex($pIndex = 0)   X-Ref
Get cellXf by index

param: int $pIndex
return: PHPExcel_Style

getCellXfByHashCode($pValue = '')   X-Ref
Get cellXf by hash code

param: string $pValue
return: PHPExcel_Style|false

cellXfExists($pCellStyle = null)   X-Ref
Check if style exists in style collection

param: PHPExcel_Style $pCellStyle
return: boolean

getDefaultStyle()   X-Ref
Get default style

return: PHPExcel_Style

addCellXf(PHPExcel_Style $style)   X-Ref
Add a cellXf to the workbook

param: PHPExcel_Style $style

removeCellXfByIndex($pIndex = 0)   X-Ref
Remove cellXf by index. It is ensured that all cells get their xf index updated.

param: integer $pIndex Index to cellXf

getCellXfSupervisor()   X-Ref
Get the cellXf supervisor

return: PHPExcel_Style

getCellStyleXfCollection()   X-Ref
Get the workbook collection of cellStyleXfs

return: PHPExcel_Style[]

getCellStyleXfByIndex($pIndex = 0)   X-Ref
Get cellStyleXf by index

param: integer $pIndex Index to cellXf
return: PHPExcel_Style

getCellStyleXfByHashCode($pValue = '')   X-Ref
Get cellStyleXf by hash code

param: string $pValue
return: PHPExcel_Style|false

addCellStyleXf(PHPExcel_Style $pStyle)   X-Ref
Add a cellStyleXf to the workbook

param: PHPExcel_Style $pStyle

removeCellStyleXfByIndex($pIndex = 0)   X-Ref
Remove cellStyleXf by index

param: integer $pIndex Index to cellXf

garbageCollect()   X-Ref
Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells
and columns in the workbook


getID()   X-Ref
Return the unique ID value assigned to this spreadsheet workbook

return: string



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1