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

Class: PHPExcel

Source Location: /PHPExcel.php

Class Overview


PHPExcel


Author(s):

Copyright:

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

Variables

Methods



Class Details

[line 55]
PHPExcel

PHPExcel




Tags:

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


[ Top ]


Class Variables

$_activeSheetIndex =  0

[line 83]

Active sheet index

Active sheet index




Tags:

access:  private

Type:   int


[ Top ]

$_namedRanges = array()

[line 90]

Named ranges

Named ranges




Tags:

access:  private

Type:   PHPExcel_NamedRange[]


[ Top ]

$_properties =

[line 62]

Document properties

Document properties




Tags:

access:  private



[ Top ]

$_security =

[line 69]

Document security

Document security




Tags:

access:  private



[ Top ]

$_workSheetCollection = array()

[line 76]

Collection of Worksheet objects

Collection of Worksheet objects




Tags:

access:  private

Type:   PHPExcel_Worksheet[]


[ Top ]



Class Methods


constructor __construct [line 95]

PHPExcel __construct( )

Create a new PHPExcel with one Worksheet

Create a new PHPExcel with one Worksheet




Tags:

access:  public


[ Top ]

method addExternalSheet [line 320]

void addExternalSheet( $pSheet)

Add external sheet

Add external sheet




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Worksheet   $pSheet   External sheet to add

[ Top ]

method addNamedRange [line 343]

void addNamedRange( PHPExcel_NamedRange $namedRange)

Add named range

Add named range




Tags:

access:  public


Parameters:

PHPExcel_NamedRange   $namedRange  

[ Top ]

method addSheet [line 182]

void addSheet( [ $pSheet = null])

Add sheet

Add sheet




Tags:

throws:  Exception
access:  public


Parameters:

PHPExcel_Worksheet   $pSheet  

[ Top ]

method copy [line 376]

PHPExcel copy( )

Copy workbook (!= clone!)

Copy workbook (!= clone!)




Tags:

access:  public


[ Top ]

method createSheet [line 167]

PHPExcel_Worksheet createSheet( )

Create sheet and add it to this workbook

Create sheet and add it to this workbook




Tags:

access:  public


[ Top ]

method getActiveSheet [line 157]

PHPExcel_Worksheet getActiveSheet( )

Get active sheet

Get active sheet




Tags:

access:  public


[ Top ]

method getActiveSheetIndex [line 278]

int getActiveSheetIndex( )

Get active sheet index

Get active sheet index




Tags:

return:  Active sheet index
access:  public


[ Top ]

method getAllSheets [line 223]

PHPExcel_Worksheet[] getAllSheets( )

Get all sheets

Get all sheets




Tags:

access:  public


[ Top ]

method getIndex [line 254]

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

void getNamedRange( string $namedRange)

Get named range

Get named range




Tags:

access:  public


Parameters:

string   $namedRange  

[ Top ]

method getNamedRanges [line 334]

PHPExcel_NamedRange[] getNamedRanges( )

Get named ranges

Get named ranges




Tags:

access:  public


[ Top ]

method getProperties [line 117]

PHPExcel_DocumentProperties getProperties( )

Get properties

Get properties




Tags:

access:  public


[ Top ]

method getSecurity [line 137]

PHPExcel_DocumentSecurity getSecurity( )

Get security

Get security




Tags:

access:  public


[ Top ]

method getSheet [line 209]

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

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

int getSheetCount( )

Get sheet count

Get sheet count




Tags:

access:  public


[ Top ]

method getSheetNames [line 303]

string[] getSheetNames( )

Get sheet names

Get sheet names




Tags:

access:  public


[ Top ]

method removeNamedRange [line 365]

void removeNamedRange( string $namedRange)

Remove named range

Remove named range




Tags:

access:  public


Parameters:

string   $namedRange  

[ Top ]

method removeSheetByIndex [line 193]

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

void 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 setProperties [line 127]

void setProperties( PHPExcel_DocumentProperties $pValue)

Set properties

Set properties




Tags:

access:  public


Parameters:

PHPExcel_DocumentProperties   $pValue  

[ Top ]

method setSecurity [line 147]

void setSecurity( PHPExcel_DocumentSecurity $pValue)

Set security

Set security




Tags:

access:  public


Parameters:

PHPExcel_DocumentSecurity   $pValue  

[ Top ]

method __clone [line 391]

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, 05 Jan 2009 20:38:22 +0100 by phpDocumentor 1.4.1