| 1 |
efrain |
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-2022, 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-2022 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 |
namespace SimplePie\Cache;
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* Interface for creating a cache filename
|
|
|
48 |
*
|
|
|
49 |
* @package SimplePie
|
|
|
50 |
* @subpackage Caching
|
|
|
51 |
*/
|
|
|
52 |
interface NameFilter
|
|
|
53 |
{
|
|
|
54 |
/**
|
|
|
55 |
* Method to create cache filename with.
|
|
|
56 |
*
|
|
|
57 |
* The returning name MUST follow the rules for keys in PSR-16.
|
|
|
58 |
*
|
|
|
59 |
* @link https://www.php-fig.org/psr/psr-16/
|
|
|
60 |
*
|
|
|
61 |
* The returning name MUST be a string of at least one character
|
|
|
62 |
* that uniquely identifies a cached item, MUST only contain the
|
|
|
63 |
* characters A-Z, a-z, 0-9, _, and . in any order in UTF-8 encoding
|
|
|
64 |
* and MUST not longer then 64 characters. The following characters
|
|
|
65 |
* are reserved for future extensions and MUST NOT be used: {}()/\@:
|
|
|
66 |
*
|
|
|
67 |
* A provided implementing library MAY support additional characters
|
|
|
68 |
* and encodings or longer lengths, but MUST support at least that
|
|
|
69 |
* minimum.
|
|
|
70 |
*
|
|
|
71 |
* @param string $name The name for the cache will be most likly an url with query string
|
|
|
72 |
*
|
|
|
73 |
* @return string the new cache name
|
|
|
74 |
*/
|
|
|
75 |
public function filter(string $name): string;
|
|
|
76 |
}
|