[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * PHPExcel_CachedObjectStorage_ICache
   5   *
   6   * Copyright (c) 2006 - 2015 PHPExcel
   7   *
   8   * This library is free software; you can redistribute it and/or
   9   * modify it under the terms of the GNU Lesser General Public
  10   * License as published by the Free Software Foundation; either
  11   * version 2.1 of the License, or (at your option) any later version.
  12   *
  13   * This library is distributed in the hope that it will be useful,
  14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16   * Lesser General Public License for more details.
  17   *
  18   * You should have received a copy of the GNU Lesser General Public
  19   * License along with this library; if not, write to the Free Software
  20   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21   *
  22   * @category   PHPExcel
  23   * @package    PHPExcel_CachedObjectStorage
  24   * @copyright  Copyright (c) 2006 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
  25   * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
  26   * @version    ##VERSION##, ##DATE##
  27   */
  28  interface PHPExcel_CachedObjectStorage_ICache
  29  {
  30      /**
  31       * Add or Update a cell in cache identified by coordinate address
  32       *
  33       * @param    string            $pCoord        Coordinate address of the cell to update
  34       * @param    PHPExcel_Cell    $cell        Cell to update
  35       * @return    PHPExcel_Cell
  36       * @throws    PHPExcel_Exception
  37       */
  38      public function addCacheData($pCoord, PHPExcel_Cell $cell);
  39  
  40      /**
  41       * Add or Update a cell in cache
  42       *
  43       * @param    PHPExcel_Cell    $cell        Cell to update
  44       * @return    PHPExcel_Cell
  45       * @throws    PHPExcel_Exception
  46       */
  47      public function updateCacheData(PHPExcel_Cell $cell);
  48  
  49      /**
  50       * Fetch a cell from cache identified by coordinate address
  51       *
  52       * @param    string            $pCoord        Coordinate address of the cell to retrieve
  53       * @return PHPExcel_Cell     Cell that was found, or null if not found
  54       * @throws    PHPExcel_Exception
  55       */
  56      public function getCacheData($pCoord);
  57  
  58      /**
  59       * Delete a cell in cache identified by coordinate address
  60       *
  61       * @param    string            $pCoord        Coordinate address of the cell to delete
  62       * @throws    PHPExcel_Exception
  63       */
  64      public function deleteCacheData($pCoord);
  65  
  66      /**
  67       * Is a value set in the current PHPExcel_CachedObjectStorage_ICache for an indexed cell?
  68       *
  69       * @param    string        $pCoord        Coordinate address of the cell to check
  70       * @return    boolean
  71       */
  72      public function isDataSet($pCoord);
  73  
  74      /**
  75       * Get a list of all cell addresses currently held in cache
  76       *
  77       * @return    string[]
  78       */
  79      public function getCellList();
  80  
  81      /**
  82       * Get the list of all cell addresses currently held in cache sorted by column and row
  83       *
  84       * @return    string[]
  85       */
  86      public function getSortedCellList();
  87  
  88      /**
  89       * Clone the cell collection
  90       *
  91       * @param    PHPExcel_Worksheet    $parent        The new worksheet
  92       * @return    void
  93       */
  94      public function copyCellCollection(PHPExcel_Worksheet $parent);
  95  
  96      /**
  97       * Identify whether the caching method is currently available
  98       * Some methods are dependent on the availability of certain extensions being enabled in the PHP build
  99       *
 100       * @return    boolean
 101       */
 102      public static function cacheMethodIsAvailable();
 103  }