Blame view

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