Docs For Class PHPExcel_Reader_OOCalc

PHPExcel_Reader

# Class: PHPExcel_Reader_OOCalc

Source Location: /PHPExcel/Reader/OOCalc.php

### Class Overview

PHPExcel_Reader_OOCalc

#### Author(s):

#### Copyright:

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

Implements interfaces:

- PHPExcel_Reader_IReader

### Methods

- __construct
- canRead
- getLoadSheetsOnly
- getReadDataOnly
- getReadFilter
- listWorksheetNames
- load
- loadIntoExisting
- setLoadAllSheets
- setLoadSheetsOnly
- setReadDataOnly
- setReadFilter

### Class Details

[line 45]
PHPExcel_Reader_OOCalc

#### Tags:

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

[ Top ]

### Class Methods

### constructor __construct [line 167]

`PHPExcel_Reader_OOCalc __construct( )`

Create a new PHPExcel_Reader_OOCalc

#### Tags:

access: | public

[ Top ]

### method canRead [line 177]

`boolean canRead( $pFilename, string $pFileName)`

Can the current PHPExcel_Reader_IReader read the file?

#### Tags:

access: | public

Implementation of:

PHPExcel_Reader_IReader::canRead()
  Can the current PHPExcel_Reader_IReader read the file?

#### Parameters:

string | $pFileName |
| $pFilename |

[ Top ]

### method getLoadSheetsOnly [line 111]

`mixed getLoadSheetsOnly( )`

Get which sheets to load Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null indicating that all worksheets in the workbook should be loaded.

#### Tags:

access: | public

[ Top ]

### method getReadDataOnly [line 86]

`boolean getReadDataOnly( )`

Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information.

If false (the default) it will read data and formatting.

#### Tags:

access: | public

[ Top ]

### method getReadFilter [line 149]

`PHPExcel_Reader_IReadFilter getReadFilter( )`

Read filter

#### Tags:

access: | public

[ Top ]

### method listWorksheetNames [line 209]

`void listWorksheetNames( string $pFilename)`

Reads names of the worksheets from a file, without parsing the whole file to a PHPExcel object

#### Tags:

throws: | Exception
access: | public

#### Parameters:

string | $pFilename |

[ Top ]

### method load [line 246]

`PHPExcel load( string $pFilename)`

Loads PHPExcel from file

#### Tags:

throws: | Exception
access: | public

Implementation of:

PHPExcel_Reader_IReader::load()
  Loads PHPExcel from file

#### Parameters:

string | $pFilename |

[ Top ]

### method loadIntoExisting [line 274]

`PHPExcel loadIntoExisting( string $pFilename, $objPHPExcel)`

Loads PHPExcel from file into PHPExcel instance

#### Tags:

throws: | Exception
access: | public

#### Parameters:

string | $pFilename |
PHPExcel | $objPHPExcel |

[ Top ]

### method setLoadAllSheets [line 138]

`PHPExcel_Reader_OOCalc setLoadAllSheets( )`

Set all sheets to load Tells the Reader to load all worksheets from the workbook.

#### Tags:

access: | public

[ Top ]

### method setLoadSheetsOnly [line 125]

`PHPExcel_Reader_OOCalc setLoadSheetsOnly( [mixed $value = null])`

Set which sheets to load

#### Tags:

access: | public

#### Parameters:

mixed | $value | This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name. If NULL, then it tells the Reader to read all worksheets in the workbook

[ Top ]

### method setReadDataOnly [line 99]

`PHPExcel_Reader_OOCalc setReadDataOnly( [boolean $pValue = false])`

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.

Set to false (the default) to advise the Reader to read both data and formatting for cells.

#### Tags:

access: | public

#### Parameters:

boolean | $pValue |

[ Top ]

### method setReadFilter [line 159]

`PHPExcel_Reader_OOCalc setReadFilter( PHPExcel_Reader_IReadFilter $pValue)`

Set read filter

#### Tags:

access: | public

#### Parameters:

PHPExcel_Reader_IReadFilter | $pValue |

[ Top ]

Documentation generated on Sun, 27 Feb 2011 16:32:59 -0800 by phpDocumentor 1.4.3