vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/Row.php

   1 <?php
   2 /**
   3  * PHPExcel
   4  *
   5  * Copyright (c) 2006 - 2014 PHPExcel
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20  *
  21  * @category   PHPExcel
  22  * @package    PHPExcel_Worksheet
  23  * @copyright  Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
  24  * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
  25  * @version    ##VERSION##, ##DATE##
  26  */
  27
  28
  29 /**
  30  * PHPExcel_Worksheet_Row
  31  *
  32  * Represents a row in PHPExcel_Worksheet, used by PHPExcel_Worksheet_RowIterator
  33  *
  34  * @category   PHPExcel
  35  * @package    PHPExcel_Worksheet
  36  * @copyright  Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
  37  */
  38 class PHPExcel_Worksheet_Row
  39 {
  40         /**
  41          * PHPExcel_Worksheet
  42          *
  43          * @var PHPExcel_Worksheet
  44          */
  45         private $_parent;
  46
  47         /**
  48          * Row index
  49          *
  50          * @var int
  51          */
  52         private $_rowIndex = 0;
  53
  54         /**
  55          * Create a new row
  56          *
  57          * @param PHPExcel_Worksheet            $parent
  58          * @param int                                           $rowIndex
  59          */
  60         public function __construct(PHPExcel_Worksheet $parent = null, $rowIndex = 1) {
  61                 // Set parent and row index
  62                 $this->_parent          = $parent;
  63                 $this->_rowIndex        = $rowIndex;
  64         }
  65
  66         /**
  67          * Destructor
  68          */
  69         public function __destruct() {
  70                 unset($this->_parent);
  71         }
  72
  73         /**
  74          * Get row index
  75          *
  76          * @return int
  77          */
  78         public function getRowIndex() {
  79                 return $this->_rowIndex;
  80         }
  81
  82         /**
  83          * Get cell iterator
  84          *
  85          * @param       string                          $startColumn    The column address at which to start iterating
  86          * @param       string                          $endColumn          Optionally, the column address at which to stop iterating
  87          * @return PHPExcel_Worksheet_CellIterator
  88          */
  89         public function getCellIterator($startColumn = 'A', $endColumn = null) {
  90                 return new PHPExcel_Worksheet_RowCellIterator($this->_parent, $this->_rowIndex, $startColumn, $endColumn);
  91         }
  92 }