Docs For Class PHPExcel_Reader_CSV

PHPExcel_Reader

# Class: PHPExcel_Reader_CSV

Source Location: /PHPExcel/Reader/CSV.php

### Class Overview

PHPExcel_Reader_CSV

#### Author(s):

#### Copyright:

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

Implements interfaces:

- PHPExcel_Reader_IReader

### Methods

- __construct
- canRead
- getContiguous
- getDelimiter
- getEnclosure
- getInputEncoding
- getLineEnding
- getReadFilter
- getSheetIndex
- load
- loadIntoExisting
- setContiguous
- setDelimiter
- setEnclosure
- setInputEncoding
- setLineEnding
- setReadFilter
- setSheetIndex

### Class Details

[line 45]
PHPExcel_Reader_CSV

#### Tags:

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

[ Top ]

### Class Methods

### constructor __construct [line 115]

`PHPExcel_Reader_CSV __construct( )`

Create a new PHPExcel_Reader_CSV

#### Tags:

access: | public

[ Top ]

### method canRead [line 127]

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

Can the current PHPExcel_Reader_IReader read the file?

#### Tags:

throws: | Exception
access: | public

Implementation of:

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

#### Parameters:

string | $pFileName |
| $pFilename |

[ Top ]

### method getContiguous [line 407]

`boolean getContiguous( )`

Get Contiguous

#### Tags:

access: | public

[ Top ]

### method getDelimiter [line 300]

`string getDelimiter( )`

Get delimiter

#### Tags:

access: | public

[ Top ]

### method getEnclosure [line 322]

`string getEnclosure( )`

Get enclosure

#### Tags:

access: | public

[ Top ]

### method getInputEncoding [line 193]

`string getInputEncoding( )`

Get input encoding

#### Tags:

access: | public

[ Top ]

### method getLineEnding [line 347]

`string getLineEnding( )`

Get line ending

#### Tags:

access: | public

[ Top ]

### method getReadFilter [line 160]

`PHPExcel_Reader_IReadFilter getReadFilter( )`

Read filter

#### Tags:

access: | public

[ Top ]

### method getSheetIndex [line 369]

`int getSheetIndex( )`

Get sheet index

#### Tags:

access: | public

[ Top ]

### method load [line 145]

`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 207]

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

Loads PHPExcel from file into PHPExcel instance

#### Tags:

throws: | Exception
access: | public

#### Parameters:

string | $pFilename |
PHPExcel | $objPHPExcel |

[ Top ]

### method setContiguous [line 391]

`void setContiguous( [ $contiguous = false], string $pValue)`

Set Contiguous

#### Tags:

access: | public

#### Parameters:

string | $pValue | Input encoding
| $contiguous |

[ Top ]

### method setDelimiter [line 311]

`PHPExcel_Reader_CSV setDelimiter( [string $pValue = ','])`

Set delimiter

#### Tags:

access: | public

#### Parameters:

string | $pValue | Delimiter, defaults to ,

[ Top ]

### method setEnclosure [line 333]

`PHPExcel_Reader_CSV setEnclosure( [string $pValue = '"'])`

Set enclosure

#### Tags:

access: | public

#### Parameters:

string | $pValue | Enclosure, defaults to "

[ Top ]

### method setInputEncoding [line 181]

`void setInputEncoding( [string $pValue = 'UTF-8'])`

Set input encoding

#### Tags:

access: | public

#### Parameters:

string | $pValue | Input encoding

[ Top ]

### method setLineEnding [line 358]

`PHPExcel_Reader_CSV setLineEnding( [string $pValue = PHP_EOL])`

Set line ending

#### Tags:

access: | public

#### Parameters:

string | $pValue | Line ending, defaults to OS line ending (PHP_EOL)

[ Top ]

### method setReadFilter [line 170]

`void setReadFilter( PHPExcel_Reader_IReadFilter $pValue)`

Set read filter

#### Tags:

access: | public

#### Parameters:

PHPExcel_Reader_IReadFilter | $pValue |

[ Top ]

### method setSheetIndex [line 380]

`PHPExcel_Reader_CSV setSheetIndex( [int $pValue = 0])`

Set sheet index

#### Tags:

access: | public

#### Parameters:

int | $pValue | Sheet index

[ Top ]

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