[Summary view]

   1  <?php
   2  
   3  declare(strict_types=1);
   4  
   5  namespace OpenSpout\Reader;
   6  
   7  /**
   8   * @template T of SheetIteratorInterface
   9   */
  10  interface ReaderInterface
  11  {
  12      /**
  13       * Prepares the reader to read the given file. It also makes sure
  14       * that the file exists and is readable.
  15       *
  16       * @param string $filePath Path of the file to be read
  17       *
  18       * @throws \OpenSpout\Common\Exception\IOException
  19       */
  20      public function open(string $filePath): void;
  21  
  22      /**
  23       * Returns an iterator to iterate over sheets.
  24       *
  25       * @return T
  26       *
  27       * @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException If called before opening the reader
  28       */
  29      public function getSheetIterator(): SheetIteratorInterface;
  30  
  31      /**
  32       * Closes the reader, preventing any additional reading.
  33       */
  34      public function close(): void;
  35  }