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