1: <?php
 2: 
 3: namespace Alpha\Util\Cache;
 4: 
 5: /**
 6:  * An interface that contains the methods for a cache implementation for storing business
 7:  * objects and other less complex values.
 8:  *
 9:  * @since 1.1
10:  *
11:  * @author John Collins <dev@alphaframework.org>
12:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
13:  * @copyright Copyright (c) 2015, John Collins (founder of Alpha Framework).
14:  * All rights reserved.
15:  *
16:  * <pre>
17:  * Redistribution and use in source and binary forms, with or
18:  * without modification, are permitted provided that the
19:  * following conditions are met:
20:  *
21:  * * Redistributions of source code must retain the above
22:  *   copyright notice, this list of conditions and the
23:  *   following disclaimer.
24:  * * Redistributions in binary form must reproduce the above
25:  *   copyright notice, this list of conditions and the
26:  *   following disclaimer in the documentation and/or other
27:  *   materials provided with the distribution.
28:  * * Neither the name of the Alpha Framework nor the names
29:  *   of its contributors may be used to endorse or promote
30:  *   products derived from this software without specific
31:  *   prior written permission.
32:  *
33:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
34:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
35:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
36:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
38:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
40:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
41:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
42:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
43:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
44:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
45:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46:  * </pre>
47:  */
48: interface CacheProviderInterface
49: {
50:     /**
51:      * Attempt to get the value from the cache for the given $key.
52:      *
53:      * @param $key
54:      *
55:      * @since 1.1
56:      *
57:      * @return mixed The expected value from the cache, boolean false otherwise
58:      */
59:     public function get($key);
60: 
61:     /**
62:      * Attempt to set the value in the cache for the given $key.  Old values on the same
63:      * key will be overwritten.
64:      *
65:      * @param $key
66:      * @param $value
67:      * @param $expiry Optional, some cache implementations will support an expiry value in seconds.
68:      *
69:      * @since 1.1
70:      */
71:     public function set($key, $value, $expiry = 0);
72: 
73:     /**
74:      * Attempt to delete the value from the cache for the given $key.
75:      *
76:      * @param $key
77:      *
78:      * @since 1.1
79:      */
80:     public function delete($key);
81: }
82: