[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  namespace Box\Spout\Reader\XLSX\Helper\SharedStringsCaching;
   4  
   5  /**
   6   * Interface CachingStrategyInterface
   7   *
   8   * @package Box\Spout\Reader\XLSX\Helper\SharedStringsCaching
   9   */
  10  interface CachingStrategyInterface
  11  {
  12      /**
  13       * Adds the given string to the cache.
  14       *
  15       * @param string $sharedString The string to be added to the cache
  16       * @param int $sharedStringIndex Index of the shared string in the sharedStrings.xml file
  17       * @return void
  18       */
  19      public function addStringForIndex($sharedString, $sharedStringIndex);
  20  
  21      /**
  22       * Closes the cache after the last shared string was added.
  23       * This prevents any additional string from being added to the cache.
  24       *
  25       * @return void
  26       */
  27      public function closeCache();
  28  
  29      /**
  30       * Returns the string located at the given index from the cache.
  31       *
  32       * @param int $sharedStringIndex Index of the shared string in the sharedStrings.xml file
  33       * @return string The shared string at the given index
  34       * @throws \Box\Spout\Reader\Exception\SharedStringNotFoundException If no shared string found for the given index
  35       */
  36      public function getStringAtIndex($sharedStringIndex);
  37  
  38      /**
  39       * Destroys the cache, freeing memory and removing any created artifacts
  40       *
  41       * @return void
  42       */
  43      public function clearCache();
  44  }