ColumnIterator.php

Go to the documentation of this file.

<?php
class PHPExcel_Worksheet_ColumnIterator implements Iterator
{
        private $_subject;

        private $_position = 0;

        private $_startColumn = 0;


        private $_endColumn = 0;


        public function __construct(PHPExcel_Worksheet $subject = null, $startColumn = 'A', $endColumn = null) {
                // Set subject
                $this->_subject = $subject;
                $this->resetEnd($endColumn);
                $this->resetStart($startColumn);
        }

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

        public function resetStart($startColumn = 'A') {
        $startColumnIndex = PHPExcel_Cell::columnIndexFromString($startColumn) - 1;
                $this->_startColumn = $startColumnIndex;
                $this->seek($startColumn);

        return $this;
        }

        public function resetEnd($endColumn = null) {
                $endColumn = ($endColumn) ? $endColumn : $this->_subject->getHighestColumn();
                $this->_endColumn = PHPExcel_Cell::columnIndexFromString($endColumn) - 1;

        return $this;
        }

        public function seek($column = 'A') {
        $column = PHPExcel_Cell::columnIndexFromString($column) - 1;
        if (($column < $this->_startColumn) || ($column > $this->_endColumn)) {
            throw new PHPExcel_Exception("Column $column is out of range ({$this->_startColumn} - {$this->_endColumn})");
        }
                $this->_position = $column;

        return $this;
    }

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

        public function current() {
                return new PHPExcel_Worksheet_Column($this->_subject, PHPExcel_Cell::stringFromColumnIndex($this->_position));
        }

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

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

        public function prev() {
        if ($this->_position <= $this->_startColumn) {
            throw new PHPExcel_Exception(
                "Column is already at the beginning of range (" . 
                PHPExcel_Cell::stringFromColumnIndex($this->_endColumn) . " - " . 
                PHPExcel_Cell::stringFromColumnIndex($this->_endColumn) . ")"
            );
        }

        --$this->_position;
        }

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