Docs For Class PHPExcel_Worksheet_CellIterator

PHPExcel_Worksheet

# Class: PHPExcel_Worksheet_CellIterator

Source Location: /PHPExcel/Worksheet/CellIterator.php

### Class Overview

    CachingIterator
       |
       --PHPExcel_Worksheet_CellIterator

PHPExcel_Worksheet_CellIterator

#### Author(s):

#### Copyright:

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

### Methods

- __construct
- __destruct
- current
- getIterateOnlyExistingCells
- key
- next
- rewind
- setIterateOnlyExistingCells
- valid

### Inherited Constants

#### Class: CachingIterator (Internal Class)

CALL_TOSTRING = 1
CATCH_GET_CHILD = 16
FULL_CACHE = 256
TOSTRING_USE_CURRENT = 4
TOSTRING_USE_INNER = 8
TOSTRING_USE_KEY = 2

### Inherited Methods

#### Class: CachingIterator (Internal Class)

constructor __construct ( $iterator, [$flags = ] )
count ( )
current ( )
getCache ( )
getFlags ( )
getInnerIterator ( )
hasNext ( )
key ( )
next ( )
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $newval )
offsetUnset ( $index )
rewind ( )
setFlags ( $flags )
valid ( )
__toString ( )

### Class Details

[line 38]
PHPExcel_Worksheet_CellIterator

Used to iterate rows in a PHPExcel_Worksheet

#### Tags:

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

[ Top ]

### Class Methods

### constructor __construct [line 74]

`PHPExcel_Worksheet_CellIterator __construct( [PHPExcel_Worksheet $subject = null], [int $rowIndex = 1])`

Create a new cell iterator

#### Tags:

access: | public

Overrides CachingIterator::constructor __construct ( $iterator, [$flags = ] ) (parent method not documented)

#### Parameters:

PHPExcel_Worksheet | $subject |
int | $rowIndex |

[ Top ]

### destructor __destruct [line 83]

`void __destruct( )`

Destructor

#### Tags:

access: | public

[ Top ]

### method current [line 99]

`PHPExcel_Cell current( )`

Current PHPExcel_Cell

#### Tags:

access: | public

Overrides CachingIterator::current ( ) (parent method not documented)
[ Top ]

### method getIterateOnlyExistingCells [line 149]

`boolean getIterateOnlyExistingCells( )`

Get loop only existing cells

#### Tags:

access: | public

[ Top ]

### method key [line 108]

`int key( )`

Current key

#### Tags:

access: | public

Overrides CachingIterator::key ( ) (parent method not documented)
[ Top ]

### method next [line 115]

`void next( )`

Next value

#### Tags:

access: | public

Overrides CachingIterator::next ( ) (parent method not documented)
[ Top ]

### method rewind [line 90]

`void rewind( )`

Rewind iterator

#### Tags:

access: | public

Overrides CachingIterator::rewind ( ) (parent method not documented)
[ Top ]

### method setIterateOnlyExistingCells [line 158]

`boolean setIterateOnlyExistingCells( [ $value = true])`

Set loop only existing cells

#### Tags:

access: | public

#### Parameters:

| $value |

[ Top ]

### method valid [line 124]

`boolean valid( )`

More PHPExcel_Cell instances available?

#### Tags:

access: | public

Overrides CachingIterator::valid ( ) (parent method not documented)
[ Top ]

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