# Interface AlphaCacheProviderInterface

An interface that contains the methods for a cache implementation for storing business objects and other less complex values.

#### Direct known implementers

AlphaCacheProviderMemcache
Package: alpha::util::cache
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, are permitted provided that the
    following conditions are met:

    * Redistributions of source code must retain the above
      copyright notice, this list of conditions and the
      following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the
      following disclaimer in the documentation and/or other
      materials provided with the distribution.
    * Neither the name of the Alpha Framework nor the names
      of its contributors may be used to endorse or promote
      products derived from this software without specific
      prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: AlphaCacheProviderInterface.inc 1496 2012-02-12 20:32:21Z alphadev $
Since: 1.1
Located at util/cache/AlphaCacheProviderInterface.inc

Methods summary
`public mixed` | # `get( mixed $key )` Attempt to get the value from the cache for the given $key. Attempt to get the value from the cache for the given $key. #### Parameters $key `mixed` $key #### Returns `mixed` The expected value from the cache, boolean false otherwise #### Since 1.1
`public` | # `set( mixed $key, mixed $value, mixed $expiry = 0 )` Attempt to set the value in the cache for the given $key. Old values on the same key will be overwritten. Attempt to set the value in the cache for the given $key. Old values on the same key will be overwritten. #### Parameters $key `mixed` $key $value `mixed` $value $expiry `mixed` $expiry Optional, some cache implementations will support an expiry value in seconds. #### Since 1.1
`public` | # `delete( mixed $key )` Attempt to delete the value from the cache for the given $key. Attempt to delete the value from the cache for the given $key. #### Parameters $key `mixed` $key #### Since 1.1