94012b50402b52ce292a9d5e171b6b271091e195.svn-base 3.3 KB

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