Docs For Class PHPExcel

PHPExcel

# Class: PHPExcel

Source Location: /PHPExcel.php

### Class Overview

PHPExcel

#### Author(s):

#### Copyright:

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

### Methods

- __construct
- addCellStyleXf
- addCellXf
- addExternalSheet
- addNamedRange
- addSheet
- copy
- createSheet
- disconnectWorksheets
- garbageCollect
- getActiveSheet
- getActiveSheetIndex
- getAllSheets
- getCellStyleXfByHashCode
- getCellStyleXfByIndex
- getCellStyleXfCollection
- getCellXfByHashCode
- getCellXfByIndex
- getCellXfCollection
- getCellXfSupervisor
- getDefaultStyle
- getIndex
- getNamedRange
- getNamedRanges
- getProperties
- getSecurity
- getSheet
- getSheetByName
- getSheetCount
- getSheetNames
- getWorksheetIterator
- removeCellStyleXfByIndex
- removeCellXfByIndex
- removeNamedRange
- removeSheetByIndex
- setActiveSheetIndex
- setActiveSheetIndexByName
- setIndexByName
- setProperties
- setSecurity
- __clone

### Class Details

[line 43]
PHPExcel

#### Tags:

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

[ Top ]

### Class Methods

### constructor __construct [line 104]

`PHPExcel __construct( )`

Create a new PHPExcel with one Worksheet

#### Tags:

access: | public

[ Top ]

### method addCellStyleXf [line 691]

`void addCellStyleXf( $pStyle)`

Add a cellStyleXf to the workbook

#### Tags:

access: | public

#### Parameters:

PHPExcel_Style | $pStyle |

[ Top ]

### method addCellXf [line 602]

`void addCellXf( $style)`

Add a cellXf to the workbook

#### Tags:

access: | public

#### Parameters:

PHPExcel_Style | $style |

[ Top ]

### method addExternalSheet [line 413]

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

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 453]

`PHPExcel addNamedRange( PHPExcel_NamedRange $namedRange)`

Add named range

#### Tags:

access: | public

#### Parameters:

PHPExcel_NamedRange | $namedRange |

[ Top ]

### method addSheet [line 209]

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

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 523]

`PHPExcel copy( )`

Copy workbook (!= clone!)

#### Tags:

access: | public

[ Top ]

### method createSheet [line 194]

`PHPExcel_Worksheet createSheet( [ $iSheetIndex = null])`

Create sheet and add it to this workbook

#### Tags:

access: | public

#### Parameters:

| $iSheetIndex |

[ Top ]

### method disconnectWorksheets [line 130]

`void disconnectWorksheets( )`

#### Tags:

access: | public

[ Top ]

### method garbageCollect [line 716]

`void garbageCollect( )`

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

and columns in the workbook

#### Tags:

access: | public

[ Top ]

### method getActiveSheet [line 184]

`PHPExcel_Worksheet getActiveSheet( )`

Get active sheet

#### Tags:

access: | public

[ Top ]

### method getActiveSheetIndex [line 350]

`int getActiveSheetIndex( )`

Get active sheet index

#### Tags:

return: | Active sheet index
access: | public

[ Top ]

### method getAllSheets [line 270]

`PHPExcel_Worksheet[] getAllSheets( )`

Get all sheets

#### Tags:

access: | public

[ Top ]

### method getCellStyleXfByHashCode [line 676]

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

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

#### Tags:

access: | public

#### Parameters:

int | $pIndex |

[ Top ]

### method getCellStyleXfCollection [line 654]

`PHPExcel_Style[] getCellStyleXfCollection( )`

Get the workbook collection of cellStyleXfs

#### Tags:

access: | public

[ Top ]

### method getCellXfByHashCode [line 573]

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

Get cellXf by hash code

#### Tags:

access: | public

#### Parameters:

string | $pValue |

[ Top ]

### method getCellXfByIndex [line 562]

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

Get cellXf by index

#### Tags:

access: | public

#### Parameters:

int | $index |
| $pIndex |

[ Top ]

### method getCellXfCollection [line 551]

`PHPExcel_Style[] getCellXfCollection( )`

Get the workbook collection of cellXfs

#### Tags:

access: | public

[ Top ]

### method getCellXfSupervisor [line 644]

`PHPExcel_Style getCellXfSupervisor( )`

Get the cellXf supervisor

#### Tags:

access: | public

[ Top ]

### method getDefaultStyle [line 589]

`PHPExcel_Style getDefaultStyle( )`

Get default style

#### Tags:

throws: | Exception
access: | public

[ Top ]

### method getIndex [line 301]

`Sheet getIndex( $pSheet)`

Get index for sheet

#### Tags:

return: | index
throws: | Exception
access: | public

#### Parameters:

PHPExcel_Worksheet | $pSheet |

[ Top ]

### method getNamedRange [line 471]

`PHPExcel_NamedRange|null getNamedRange( string $namedRange, [ $pSheet = null])`

Get named range

#### Tags:

access: | public

#### Parameters:

string | $namedRange |
PHPExcel_Worksheet|null | $pSheet | Scope. Use null for global scope

[ Top ]

### method getNamedRanges [line 443]

`PHPExcel_NamedRange[] getNamedRanges( )`

Get named ranges

#### Tags:

access: | public

[ Top ]

### method getProperties [line 144]

`PHPExcel_DocumentProperties getProperties( )`

Get properties

#### Tags:

access: | public

[ Top ]

### method getSecurity [line 164]

`PHPExcel_DocumentSecurity getSecurity( )`

Get security

#### Tags:

access: | public

[ Top ]

### method getSheet [line 256]

`PHPExcel_Worksheet getSheet( [int $pIndex = 0])`

Get sheet by index

#### Tags:

throws: | Exception
access: | public

#### Parameters:

int | $pIndex | Sheet index

[ Top ]

### method getSheetByName [line 282]

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

Get sheet by name

#### Tags:

throws: | Exception
access: | public

#### Parameters:

string | $pName | Sheet name

[ Top ]

### method getSheetCount [line 340]

`int getSheetCount( )`

Get sheet count

#### Tags:

access: | public

[ Top ]

### method getSheetNames [line 394]

`string[] getSheetNames( )`

Get sheet names

#### Tags:

access: | public

[ Top ]

### method getWorksheetIterator [line 514]

`PHPExcel_WorksheetIterator getWorksheetIterator( )`

Get worksheet iterator

#### Tags:

access: | public

[ Top ]

### method removeCellStyleXfByIndex [line 703]

`void removeCellStyleXfByIndex( [int $pIndex = 0])`

Remove cellStyleXf by index

#### Tags:

throws: | Exception
access: | public

#### Parameters:

int | $pIndex |

[ Top ]

### method removeCellXfByIndex [line 614]

`void removeCellXfByIndex( [int $pIndex = 0])`

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 496]

`PHPExcel removeNamedRange( string $namedRange, [ $pSheet = null], PHPExcel_Worksheet|null $pSheet.)`

Remove named range

#### Tags:

access: | public

#### Parameters:

string | $namedRange |
PHPExcel_Worksheet|null | $pSheet. | Scope. Use null for global scope.
PHPExcel_Worksheet | $pSheet |

[ Top ]

### method removeSheetByIndex [line 240]

`void removeSheetByIndex( [int $pIndex = 0])`

Remove sheet by index

#### Tags:

throws: | Exception
access: | public

#### Parameters:

int | $pIndex | Active sheet index

[ Top ]

### method setActiveSheetIndex [line 362]

`PHPExcel_Worksheet setActiveSheetIndex( [int $pIndex = 0])`

Set active sheet index

#### Tags:

throws: | Exception
access: | public

#### Parameters:

int | $pIndex | Active sheet index

[ Top ]

### method setActiveSheetIndexByName [line 379]

`PHPExcel_Worksheet setActiveSheetIndexByName( [string $pValue = ''])`

Set active sheet index by name

#### Tags:

throws: | Exception
access: | public

#### Parameters:

string | $pValue | Sheet title

[ Top ]

### method setIndexByName [line 318]

`New setIndexByName( string $sheetName, int $newIndex)`

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 154]

`void setProperties( PHPExcel_DocumentProperties $pValue)`

Set properties

#### Tags:

access: | public

#### Parameters:

PHPExcel_DocumentProperties | $pValue |

[ Top ]

### method setSecurity [line 174]

`void setSecurity( PHPExcel_DocumentSecurity $pValue)`

Set security

#### Tags:

access: | public

#### Parameters:

PHPExcel_DocumentSecurity | $pValue |

[ Top ]

### method __clone [line 538]

`void __clone( )`

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

#### Tags:

access: | public

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:33:26 -0800 by phpDocumentor 1.4.3