ColumnCellIterator.php

Go to the documentation of this file.

<?php
class PHPExcel_Worksheet_ColumnCellIterator extends PHPExcel_Worksheet_CellIterator implements Iterator
{
        protected $_columnIndex;

        protected $_startRow = 1;

        protected $_endRow = 1;

        public function __construct(PHPExcel_Worksheet $subject = null, $columnIndex, $startRow = 1, $endRow = null) {
                // Set subject
                $this->_subject = $subject;
                $this->_columnIndex = PHPExcel_Cell::columnIndexFromString($columnIndex) - 1;
                $this->resetEnd($endRow);
                $this->resetStart($startRow);
        }

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

        public function resetStart($startRow = 1) {
                $this->_startRow = $startRow;
        $this->adjustForExistingOnlyRange();
                $this->seek($startRow);

        return $this;
        }

        public function resetEnd($endRow = null) {
                $this->_endRow = ($endRow) ? $endRow : $this->_subject->getHighestRow();
        $this->adjustForExistingOnlyRange();

        return $this;
        }

        public function seek($row = 1) {
        if (($row < $this->_startRow) || ($row > $this->_endRow)) {
            throw new PHPExcel_Exception("Row $row is out of range ({$this->_startRow} - {$this->_endRow})");
        } elseif ($this->_onlyExistingCells && !($this->_subject->cellExistsByColumnAndRow($this->_columnIndex, $row))) {
            throw new PHPExcel_Exception('In "IterateOnlyExistingCells" mode and Cell does not exist');
        }
                $this->_position = $row;

        return $this;
        }

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

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

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

        public function next() {
        do {
            ++$this->_position;
        } while (($this->_onlyExistingCells) &&
            (!$this->_subject->cellExistsByColumnAndRow($this->_columnIndex, $this->_position)) &&
            ($this->_position <= $this->_endRow));
        }

        public function prev() {
        if ($this->_position <= $this->_startRow) {
            throw new PHPExcel_Exception("Row is already at the beginning of range ({$this->_startRow} - {$this->_endRow})");
        }

        do {
            --$this->_position;
        } while (($this->_onlyExistingCells) &&
            (!$this->_subject->cellExistsByColumnAndRow($this->_columnIndex, $this->_position)) &&
            ($this->_position >= $this->_startRow));
        }

        public function valid() {
                return $this->_position <= $this->_endRow;
        }

    protected function adjustForExistingOnlyRange() {
        if ($this->_onlyExistingCells) {
            while ((!$this->_subject->cellExistsByColumnAndRow($this->_columnIndex, $this->_startRow)) &&
                ($this->_startRow <= $this->_endRow)) {
                ++$this->_startRow;
            }
            if ($this->_startRow > $this->_endRow) {
                throw new PHPExcel_Exception('No cells exist within the specified range');
            }
            while ((!$this->_subject->cellExistsByColumnAndRow($this->_columnIndex, $this->_endRow)) &&
                ($this->_endRow >= $this->_startRow)) {
                --$this->_endRow;
            }
            if ($this->_endRow < $this->_startRow) {
                throw new PHPExcel_Exception('No cells exist within the specified range');
            }
        }
    }

}