[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace Box\Spout\Writer\Common\Internal;
   4  
   5  /**
   6   * Interface WorksheetInterface
   7   *
   8   * @package Box\Spout\Writer\Common\Internal
   9   */
  10  interface WorksheetInterface
  11  {
  12      /**
  13       * @return \Box\Spout\Writer\Common\Sheet The "external" sheet
  14       */
  15      public function getExternalSheet();
  16  
  17      /**
  18       * @return int The index of the last written row
  19       */
  20      public function getLastWrittenRowIndex();
  21  
  22      /**
  23       * Adds data to the worksheet.
  24       *
  25       * @param array $dataRow Array containing data to be written.
  26       *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
  27       * @param \Box\Spout\Writer\Style\Style $style Style to be applied to the row. NULL means use default style.
  28       * @return void
  29       * @throws \Box\Spout\Common\Exception\IOException If the data cannot be written
  30       * @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
  31       */
  32      public function addRow($dataRow, $style);
  33  
  34      /**
  35       * Closes the worksheet
  36       *
  37       * @return void
  38       */
  39      public function close();
  40  }