     1: <?php
     2:
     3: /**
     4:  *
     5:  * An interface that contains the methods for a cache implementation for storing business
     6:  * objects and other less complex values.
     7:  *
     8:  * @package alpha::util::cache
     9:  * @since 1.1
    10:  * @author John Collins <dev@alphaframework.org>
    11:  * @version $Id: AlphaCacheProviderInterface.inc 1693 2013-12-09 23:33:24Z alphadevx $
    12:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
    13:  * @copyright Copyright (c) 2013, 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:  */
    49: interface AlphaCacheProviderInterface {
    50:     /**
    51:      * Attempt to get the value from the cache for the given $key.
    52:      *
    53:      * @param $key
    54:      * @since 1.1
    55:      * @return mixed The expected value from the cache, boolean false otherwise
    56:      */
    57:     public function get($key);
    58:
    59:     /**
    60:      * Attempt to set the value in the cache for the given $key.  Old values on the same
    61:      * key will be overwritten.
    62:      *
    63:      * @param $key
    64:      * @param $value
    65:      * @param $expiry Optional, some cache implementations will support an expiry value in seconds.
    66:      * @since 1.1
    67:      */
    68:     public function set($key, $value, $expiry=0);
    69:
    70:     /**
    71:      * Attempt to delete the value from the cache for the given $key.
    72:      *
    73:      * @param $key
    74:      * @since 1.1
    75:      */
    76:     public function delete($key);
    77: }
    78:
    79: ?>