CellIterator.php

Go to the documentation of this file.

<?php
class PHPExcel_Worksheet_CellIterator extends CachingIterator
{
        private $_subject;

        private $_rowIndex;

        private $_position = 0;

        private $_onlyExistingCells = true;

        public function __construct(PHPExcel_Worksheet $subject = null, $rowIndex = 1) {
                // Set subject and row index
                $this->_subject         = $subject;
                $this->_rowIndex        = $rowIndex;
        }

        public function __destruct() {
                unset($this->_subject);
        }

    public function rewind() {
        $this->_position = 0;
    }

    public function current() {
                return $this->_subject->getCellByColumnAndRow($this->_position, $this->_rowIndex);
    }

    public function key() {
        return $this->_position;
    }

    public function next() {
        ++$this->_position;
    }

    public function valid() {
        // columnIndexFromString() returns an index based at one,
        // treat it as a count when comparing it to the base zero
        // position.
        $columnCount = PHPExcel_Cell::columnIndexFromString($this->_subject->getHighestColumn());

        if ($this->_onlyExistingCells) {
            // If we aren't looking at an existing cell, either
            // because the first column doesn't exist or next() has
            // been called onto a nonexistent cell, then loop until we
            // find one, or pass the last column.
            while ($this->_position < $columnCount &&
                   !$this->_subject->cellExistsByColumnAndRow($this->_position, $this->_rowIndex)) {
                ++$this->_position;
            }
        }

        return $this->_position < $columnCount;
    }

    public function getIterateOnlyExistingCells() {
        return $this->_onlyExistingCells;
    }

    public function setIterateOnlyExistingCells($value = true) {
        $this->_onlyExistingCells = $value;
    }
}