PHPExcel
[ class tree: PHPExcel ] [ index: PHPExcel ] [ all elements ]

Class: PHPExcel

Source Location: /PHPExcel.php

Class Overview


PHPExcel


Author(s):

Copyright:

  • Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)

Variables

Methods



Class Details

[line 63]
PHPExcel

PHPExcel




Tags:

copyright:  Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)


[ Top ]


Class Variables

$_activeSheetIndex =  0

[line 91]

Active sheet index

Active sheet index




Tags:

access:  private

Type:   int


[ Top ]

$_cellStyleXfCollection = array()

[line 119]

CellStyleXf collection

CellStyleXf collection




Tags:

access:  private

Type:   PHPExcel_Style[]


[ Top ]

$_cellXfCollection = array()

[line 112]

CellXf collection

CellXf collection




Tags:

access:  private

Type:   PHPExcel_Style[]


[ Top ]

$_cellXfSupervisor =

[line 105]

CellXf supervisor

CellXf supervisor




Tags:

access:  private

Type:   PHPExcel_Style


[ Top ]

$_namedRanges = array()

[line 98]

Named ranges

Named ranges




Tags:

access:  private

Type:   PHPExcel_NamedRange[]


[ Top ]

$_properties =

[line 70]

Document properties

Document properties




Tags:

access:  private



[ Top ]

$_security =

[line 77]

Document security

Document security




Tags:

access:  private



[ Top ]

$_workSheetCollection = array()

[line 84]

Collection of Worksheet objects

Collection of Worksheet objects




Tags:

access:  private

Type:   PHPExcel_Worksheet[]


[ Top ]



Class Methods


constructor __construct [line 124]

PHPExcel __construct( )

Create a new PHPExcel with one Worksheet

Create a new PHPExcel with one Worksheet




Tags:

access:  public


[ Top ]

method addCellStyleXf [line 691]

void addCellStyleXf( $pStyle)

Add a cellStyleXf to the workbook

Add a cellStyleXf to the workbook




Tags:

access:  public


Parameters:

PHPExcel_Style   $pStyle  

[ Top ]

method addCellXf [line 603]

void addCellXf( $style)

Add a cellXf to the workbook

Add a cellXf to the workbook




Tags:

access:  public


Parameters:

PHPExcel_Style   $style  

[ Top ]

method addExternalSheet [line 406]

PHPExcel_Worksheet addExternalSheet( $pSheet, [int|null $iSheetIndex = null])

Add external sheet

Add external sheet




Tags:

throws:  Exception
access:  public


Parameters:

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

[ Top ]

method addNamedRange [line 445]

PHPExcel addNamedRange( PHPExcel_NamedRange $namedRange)

Add named range

Add named range




Tags:

access:  public


Parameters:

PHPExcel_NamedRange   $namedRange  

[ Top ]

method addSheet [line 219]

PHPExcel_Worksheet addSheet( [ $pSheet = null], [int|null $iSheetIndex = null])

Add sheet

Add sheet




Tags:

throws:  Exception
access:  public


Parameters:

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

[ Top ]

method copy [line 524]

PHPExcel copy( )

Copy workbook (!= clone!)

Copy workbook (!= clone!)




Tags:

access:  public


[ Top ]

method createSheet [line 204]

PHPExcel_Worksheet createSheet( [ $iSheetIndex = null])

Create sheet and add it to this workbook

Create sheet and add it to this workbook




Tags:

access:  public


Parameters:

   $iSheetIndex  

[ Top ]

method garbageCollect [line 716]

void garbageCollect( )

Eliminate all unneeded cellXf and afterwards update the xfIndex for all cells

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




Tags:

access:  public


[ Top ]

method getActiveSheet [line 194]

PHPExcel_Worksheet getActiveSheet( )

Get active sheet

Get active sheet




Tags:

access:  public


[ Top ]

method getActiveSheetIndex [line 360]

int getActiveSheetIndex( )

Get active sheet index

Get active sheet index




Tags:

return:  Active sheet index
access:  public


[ Top ]

method getAllSheets [line 280]

PHPExcel_Worksheet[] getAllSheets( )

Get all sheets

Get all sheets




Tags:

access:  public


[ Top ]

method getCellStyleXfByHashCode [line 676]

PHPExcel_Style|false getCellStyleXfByHashCode( [string $pValue = ''])

Get cellStyleXf by hash code

Get cellStyleXf by hash code




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method getCellStyleXfByIndex [line 665]

PHPExcel_Style getCellStyleXfByIndex( [int $pIndex = 0])

Get cellStyleXf by index

Get cellStyleXf by index




Tags:

access:  public


Parameters:

int   $pIndex  

[ Top ]

method getCellStyleXfCollection [line 654]

PHPExcel_Style[] getCellStyleXfCollection( )

Get the workbook collection of cellStyleXfs

Get the workbook collection of cellStyleXfs




Tags:

access:  public


[ Top ]

method getCellXfByHashCode [line 574]

PHPExcel_Style|false getCellXfByHashCode( [string $pValue = ''])

Get cellXf by hash code

Get cellXf by hash code




Tags:

access:  public


Parameters:

string   $pValue  

[ Top ]

method getCellXfByIndex [line 563]

PHPExcel_Style getCellXfByIndex( [ $pIndex = 0], int $index)

Get cellXf by index

Get cellXf by index




Tags:

access:  public


Parameters:

int   $index  
   $pIndex  

[ Top ]

method getCellXfCollection [line 552]

PHPExcel_Style[] getCellXfCollection( )

Get the workbook collection of cellXfs

Get the workbook collection of cellXfs




Tags:

access:  public


[ Top ]

method getCellXfSupervisor [line 644]

PHPExcel_Style getCellXfSupervisor( )

Get the cellXf supervisor

Get the cellXf supervisor




Tags:

access:  public


[ Top ]

method getDefaultStyle [line 590]

PHPExcel_Style getDefaultStyle( )

Get default style

Get default style




Tags:

throws:  Exception
access:  public


[ Top ]

method getIndex [line 311]

Sheet getIndex( $pSheet)

Get index for sheet

Get index for sheet




Tags:

return:  index
throws:  Exception
access:  public


Parameters:

PHPExcel_Worksheet   $pSheet  

[ Top ]

method getNamedRange [line 455]

void getNamedRange( string $namedRange, [ $pSheet = null])

Get named range

Get named range




Tags:

access:  public


Parameters:

string   $namedRange  
PHPExcel_Worksheet   $pSheet  

[ Top ]

method getNamedRanges [line 435]

PHPExcel_NamedRange[] getNamedRanges( )

Get named ranges

Get named ranges




Tags:

access:  public


[ Top ]

method getProperties [line 154]

PHPExcel_DocumentProperties getProperties( )

Get properties

Get properties




Tags:

access:  public


[ Top ]

method getSecurity [line 174]

PHPExcel_DocumentSecurity getSecurity( )

Get security

Get security




Tags:

access:  public


[ Top ]

method getSheet [line 266]

PHPExcel_Worksheet getSheet( [int $pIndex = 0])

Get sheet by index

Get sheet by index




Tags:

throws:  Exception
access:  public


Parameters:

int   $pIndex   Sheet index

[ Top ]

method getSheetByName [line 292]

PHPExcel_Worksheet getSheetByName( [string $pName = ''])

Get sheet by name

Get sheet by name




Tags:

throws:  Exception
access:  public


Parameters:

string   $pName   Sheet name

[ Top ]

method getSheetCount [line 350]

int getSheetCount( )

Get sheet count

Get sheet count




Tags:

access:  public


[ Top ]

method getSheetNames [line 387]

string[] getSheetNames( )

Get sheet names

Get sheet names




Tags:

access:  public


[ Top ]

method getWorksheetIterator [line 515]

PHPExcel_WorksheetIterator getWorksheetIterator( )

Get worksheet iterator

Get worksheet iterator




Tags:

access:  public


[ Top ]

method removeCellStyleXfByIndex [line 703]

void removeCellStyleXfByIndex( [int $pIndex = 0])

Remove cellStyleXf by index

Remove cellStyleXf by index




Tags:

throws:  Exception
access:  public


Parameters:

int   $pIndex  

[ Top ]

method removeCellXfByIndex [line 615]

void removeCellXfByIndex( [int $pIndex = 0])

Remove cellXf by index.

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




Tags:

throws:  Exception
access:  public


Parameters:

int   $pIndex   Index to cellXf

[ Top ]

method removeNamedRange [line 488]

PHPExcel removeNamedRange( string $namedRange, [ $pSheet = null])

Remove named range

Remove named range




Tags:

access:  public


Parameters:

string   $namedRange  
PHPExcel_Worksheet   $pSheet  

[ Top ]

method removeSheetByIndex [line 250]

void removeSheetByIndex( [int $pIndex = 0])

Remove sheet by index

Remove sheet by index




Tags:

throws:  Exception
access:  public


Parameters:

int   $pIndex   Active sheet index

[ Top ]

method setActiveSheetIndex [line 372]

PHPExcel_Worksheet setActiveSheetIndex( [int $pIndex = 0])

Set active sheet index

Set active sheet index




Tags:

throws:  Exception
access:  public


Parameters:

int   $pIndex   Active sheet index

[ Top ]

method setIndexByName [line 328]

New setIndexByName( string $sheetName, int $newIndex)

Set index for sheet by sheet name.

Set index for sheet by sheet name.




Tags:

return:  sheet index
throws:  Exception
access:  public


Parameters:

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

[ Top ]

method setProperties [line 164]

void setProperties( PHPExcel_DocumentProperties $pValue)

Set properties

Set properties




Tags:

access:  public


Parameters:

PHPExcel_DocumentProperties   $pValue  

[ Top ]

method setSecurity [line 184]

void setSecurity( PHPExcel_DocumentSecurity $pValue)

Set security

Set security




Tags:

access:  public


Parameters:

PHPExcel_DocumentSecurity   $pValue  

[ Top ]

method __clone [line 539]

void __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.




Tags:

access:  public


[ Top ]


Documentation generated on Mon, 11 Jan 2010 08:12:56 +0100 by phpDocumentor 1.4.1