Base.php 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?php
  2. /**
  3. * SimplePie
  4. *
  5. * A PHP-Based RSS and Atom Feed Framework.
  6. * Takes the hard work out of managing a complete RSS/Atom solution.
  7. *
  8. * Copyright (c) 2004-2016, Ryan Parman, Sam Sneddon, Ryan McCue, and contributors
  9. * All rights reserved.
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification, are
  12. * permitted provided that the following conditions are met:
  13. *
  14. * * Redistributions of source code must retain the above copyright notice, this list of
  15. * conditions and the following disclaimer.
  16. *
  17. * * Redistributions in binary form must reproduce the above copyright notice, this list
  18. * of conditions and the following disclaimer in the documentation and/or other materials
  19. * provided with the distribution.
  20. *
  21. * * Neither the name of the SimplePie Team nor the names of its contributors may be used
  22. * to endorse or promote products derived from this software without specific prior
  23. * written permission.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
  26. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  27. * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
  28. * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32. * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33. * POSSIBILITY OF SUCH DAMAGE.
  34. *
  35. * @package SimplePie
  36. * @copyright 2004-2016 Ryan Parman, Sam Sneddon, Ryan McCue
  37. * @author Ryan Parman
  38. * @author Sam Sneddon
  39. * @author Ryan McCue
  40. * @link http://simplepie.org/ SimplePie
  41. * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  42. */
  43. /**
  44. * Base for cache objects
  45. *
  46. * Classes to be used with {@see SimplePie_Cache::register()} are expected
  47. * to implement this interface.
  48. *
  49. * @package SimplePie
  50. * @subpackage Caching
  51. */
  52. interface SimplePie_Cache_Base
  53. {
  54. /**
  55. * Feed cache type
  56. *
  57. * @var string
  58. */
  59. const TYPE_FEED = 'spc';
  60. /**
  61. * Image cache type
  62. *
  63. * @var string
  64. */
  65. const TYPE_IMAGE = 'spi';
  66. /**
  67. * Create a new cache object
  68. *
  69. * @param string $location Location string (from SimplePie::$cache_location)
  70. * @param string $name Unique ID for the cache
  71. * @param string $type Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data
  72. */
  73. public function __construct($location, $name, $type);
  74. /**
  75. * Save data to the cache
  76. *
  77. * @param array|SimplePie $data Data to store in the cache. If passed a SimplePie object, only cache the $data property
  78. * @return bool Successfulness
  79. */
  80. public function save($data);
  81. /**
  82. * Retrieve the data saved to the cache
  83. *
  84. * @return array Data for SimplePie::$data
  85. */
  86. public function load();
  87. /**
  88. * Retrieve the last modified time for the cache
  89. *
  90. * @return int Timestamp
  91. */
  92. public function mtime();
  93. /**
  94. * Set the last modified time to the current time
  95. *
  96. * @return bool Success status
  97. */
  98. public function touch();
  99. /**
  100. * Remove the cache
  101. *
  102. * @return bool Success status
  103. */
  104. public function unlink();
  105. }