Alpha Framework alpha--util--cache
[ class tree: alpha--util--cache ] [ index: alpha--util--cache ] [ all elements ]

Interface: AlphaCacheProviderInterface

Source Location: /util/cache/AlphaCacheProviderInterface.inc

Interface AlphaCacheProviderInterface

Interface Overview

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

Located in /util/cache/AlphaCacheProviderInterface.inc [line 49]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: AlphaCacheProviderInterface.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright:  

Copyright (c) 2011, 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.

Since:  1.1
License:  The BSD License

Methods

[ Top ]
Method Summary
void   delete()   Attempt to delete the value from the cache for the given $key.
mixed   get()   Attempt to get the value from the cache for the given $key.
void   set()   Attempt to set the value in the cache for the given $key. Old values on the same key will be overwritten.

[ Top ]
Methods
delete  [line 76]

  void delete( $key $key  )

Attempt to delete the value from the cache for the given $key.

Parameters:
$key   $key: 

API Tags:
Access:  public

Information Tags:
Since:  1.1

[ Top ]
get  [line 57]

  mixed get( $key $key  )

Attempt to get the value from the cache for the given $key.

Parameters:
$key   $key: 

API Tags:
Return:  The expected value from the cache, boolean false otherwise
Access:  public

Information Tags:
Since:  1.1

[ Top ]
set  [line 68]

  void set( $key $key, $value $value, [$expiry $expiry = 0]  )

Attempt to set the value in the cache for the given $key. Old values on the same key will be overwritten.

Parameters:
$key   $key: 
$value   $value: 
$expiry   $expiry:  Optional, some cache implementations will support an expiry value in seconds.

API Tags:
Access:  public

Information Tags:
Since:  1.1

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:25:31 +0000 by phpDocumentor 1.4.3