| @@ -1,5 +1,18 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * CacheProviderInterface.php | |
| 4 | + * | |
| 5 | + * The CacheProviderInterface interface file. | |
| 6 | + * | |
| 7 | + * PHP versions 5 | |
| 8 | + * | |
| 9 | + * @author Alexander Schneider <alexanderschneider85@gmail.com> | |
| 10 | + * @copyright 2008-2017 Alexander Schneider | |
| 11 | + * @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2 | |
| 12 | + * @version SVN: $id$ | |
| 13 | + * @link http://wordpress.org/extend/plugins/user-access-manager/ | |
| 14 | + */ | |
| 2 | 15 | |
| 3 | 16 | declare(strict_types=1); |
| 4 | 17 | |
| 5 | 18 | namespace UserAccessManager\Cache; |
| @@ -5,18 +18,48 @@ | ||
| 5 | 18 | namespace UserAccessManager\Cache; |
| 6 | 19 | |
| 7 | 20 | use UserAccessManager\Config\Config; |
| 8 | 21 | |
| 22 | +/** | |
| 23 | + * Interface CacheProviderInterface | |
| 24 | + * | |
| 25 | + * @package UserAccessManager\Cache | |
| 26 | + */ | |
| 9 | 27 | interface CacheProviderInterface |
| 10 | 28 | { |
| 29 | + /** | |
| 30 | + * Returns the id of the cache provider. | |
| 31 | + * @return string | |
| 32 | + */ | |
| 11 | 33 | public function getId(): string; |
| 12 | 34 | |
| 13 | - public function init(): void; | |
| 35 | + /** | |
| 36 | + * Initialises the cache provider object. | |
| 37 | + */ | |
| 38 | + public function init(); | |
| 14 | 39 | |
| 40 | + /** | |
| 41 | + * Returns the cache provider configuration. | |
| 42 | + * @return Config | |
| 43 | + */ | |
| 15 | 44 | public function getConfig(): Config; |
| 16 | 45 | |
| 17 | - public function add(string $key, mixed $value); | |
| 46 | + /** | |
| 47 | + * Adds a value to the cache. | |
| 48 | + * @param string $key | |
| 49 | + * @param mixed $value | |
| 50 | + */ | |
| 51 | + public function add(string $key, $value); | |
| 18 | 52 | |
| 19 | - public function get(string $key): mixed; | |
| 53 | + /** | |
| 54 | + * Returns a value from the cache. | |
| 55 | + * @param string $key | |
| 56 | + * @return mixed | |
| 57 | + */ | |
| 58 | + public function get(string $key); | |
| 20 | 59 | |
| 60 | + /** | |
| 61 | + * Invalidates the cache. | |
| 62 | + * @param string $key | |
| 63 | + */ | |
| 21 | 64 | public function invalidate(string $key); |
| 22 | 65 | } |