You are here

abstract class PHPExcel_Worksheet_CellIterator in Loft Data Grids 6.2

Same name and namespace in other branches
  1. 7.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/CellIterator.php \PHPExcel_Worksheet_CellIterator

PHPExcel_Worksheet_CellIterator

Used to iterate rows in a PHPExcel_Worksheet

@category PHPExcel @package PHPExcel_Worksheet @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

Expanded class hierarchy of PHPExcel_Worksheet_CellIterator

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/CellIterator.php, line 38

View source
abstract class PHPExcel_Worksheet_CellIterator {

  /**
   * PHPExcel_Worksheet to iterate
   *
   * @var PHPExcel_Worksheet
   */
  protected $_subject;

  /**
   * Current iterator position
   *
   * @var mixed
   */
  protected $_position = null;

  /**
   * Iterate only existing cells
   *
   * @var boolean
   */
  protected $_onlyExistingCells = false;

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

  /**
   * Get loop only existing cells
   *
   * @return boolean
   */
  public function getIterateOnlyExistingCells() {
    return $this->_onlyExistingCells;
  }

  /**
   * Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary
   *
   * @throws PHPExcel_Exception
   */
  protected abstract function adjustForExistingOnlyRange();

  /**
   * Set the iterator to loop only existing cells
   *
   * @param	boolean		$value
   * @throws PHPExcel_Exception
   */
  public function setIterateOnlyExistingCells($value = true) {
    $this->_onlyExistingCells = (bool) $value;
    $this
      ->adjustForExistingOnlyRange();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPExcel_Worksheet_CellIterator::$_onlyExistingCells protected property * Iterate only existing cells * *
PHPExcel_Worksheet_CellIterator::$_position protected property * Current iterator position * *
PHPExcel_Worksheet_CellIterator::$_subject protected property * PHPExcel_Worksheet to iterate * *
PHPExcel_Worksheet_CellIterator::adjustForExistingOnlyRange abstract protected function * Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary * 2
PHPExcel_Worksheet_CellIterator::getIterateOnlyExistingCells public function * Get loop only existing cells * *
PHPExcel_Worksheet_CellIterator::setIterateOnlyExistingCells public function * Set the iterator to loop only existing cells * *
PHPExcel_Worksheet_CellIterator::__destruct public function * Destructor 2