CellIterator.php

Go to the documentation of this file.

<?php
if (!defined('PHPEXCEL_ROOT')) {
        define('PHPEXCEL_ROOT', dirname(__FILE__) . '/../../');
}

require_once PHPEXCEL_ROOT . 'PHPExcel.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/Worksheet.php';

require_once PHPEXCEL_ROOT . 'PHPExcel/Cell.php';


class PHPExcel_Worksheet_CellIterator extends IteratorIterator
{
        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() {
                $cellExists = $this->_subject->cellExistsByColumnAndRow($this->_position, $this->_rowIndex);
        if ( ($this->_onlyExistingCells && $cellExists) || (!$this->_onlyExistingCells) ) {
                return $this->_subject->getCellByColumnAndRow($this->_position, $this->_rowIndex);
        } else if ($this->_onlyExistingCells && !$cellExists) {
                        // Loop untill we find one
                        while ($this->valid()) {
                                $this->next();
                                if ($this->_subject->cellExistsByColumnAndRow($this->_position, $this->_rowIndex)) {
                                        return $this->_subject->getCellByColumnAndRow($this->_position, $this->_rowIndex);
                                }
                        }
                }
        
        return null;
    }

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

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

    public function valid() {
        return $this->_position < PHPExcel_Cell::columnIndexFromString( $this->_subject->getHighestColumn() );
    }
    
    public function getIterateOnlyExistingCells() {
        return $this->_onlyExistingCells;
    }
    
    public function setIterateOnlyExistingCells($value = true) {
        $this->_onlyExistingCells = $value;
    }
}