[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace Box\Spout\Reader\XLSX;
   4  
   5  use Box\Spout\Reader\SheetInterface;
   6  
   7  /**
   8   * Class Sheet
   9   * Represents a sheet within a XLSX file
  10   *
  11   * @package Box\Spout\Reader\XLSX
  12   */
  13  class Sheet implements SheetInterface
  14  {
  15      /** @var \Box\Spout\Reader\XLSX\RowIterator To iterate over sheet's rows */
  16      protected $rowIterator;
  17  
  18      /** @var int Index of the sheet, based on order in the workbook (zero-based) */
  19      protected $index;
  20  
  21      /** @var string Name of the sheet */
  22      protected $name;
  23  
  24      /**
  25       * @param string $filePath Path of the XLSX file being read
  26       * @param string $sheetDataXMLFilePath Path of the sheet data XML file as in [Content_Types].xml
  27       * @param Helper\SharedStringsHelper Helper to work with shared strings
  28       * @param int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
  29       * @param string $sheetName Name of the sheet
  30       */
  31      public function __construct($filePath, $sheetDataXMLFilePath, $sharedStringsHelper, $sheetIndex, $sheetName)
  32      {
  33          $this->rowIterator = new RowIterator($filePath, $sheetDataXMLFilePath, $sharedStringsHelper);
  34          $this->index = $sheetIndex;
  35          $this->name = $sheetName;
  36      }
  37  
  38      /**
  39       * @api
  40       * @return \Box\Spout\Reader\XLSX\RowIterator
  41       */
  42      public function getRowIterator()
  43      {
  44          return $this->rowIterator;
  45      }
  46  
  47      /**
  48       * @api
  49       * @return int Index of the sheet, based on order in the workbook (zero-based)
  50       */
  51      public function getIndex()
  52      {
  53          return $this->index;
  54      }
  55  
  56      /**
  57       * @api
  58       * @return string Name of the sheet
  59       */
  60      public function getName()
  61      {
  62          return $this->name;
  63      }
  64  }