~registry/hippo/trunk

 * API for all cache engine adapters.  

 *

 * @ingroup Cache

 */

interface HippoCacheEngine {

        /**

         * All subclasses must implement a get() method to return

         * a cached item.

         *

         * @return      mixed                                                           FALSE if not in cache, otherwise the cached item

         * @param               key                                                                     Key to the cache item

         * @param               options                                                 Options to pass to the cache engine (see engine specifics)

         */

        public function get($key, $options= array());

 

        /**

         * All subclasses must implement a set() method to 

         * write the cache item to the cache

         *

         * @return      bool                                                            Did the write succeed?

         * @param               key                                                                     The key for the cache item

         * @param               value                                                           The value of the cache item

         */

        public function set($key, $value);

 

        /**

         * All subclasses must implement a delete() method to 

         * remove a cache item from the cache

         *

         * @return      bool                                                            Did the delete succeed?

         * @param               key                                                                     The key for the cache item

         */

        public function delete($key);

 

        /**

         * All subclasses must implement a purge() method to 

         * remove blocks of cache items from the cache

         * 

         *      optional options argument can contain subclass-specific

         *      arguments for the purge.

         *

         * @return      bool            Did the purge succeed?

         * @param               options Options to pass the subclass-specific interface

         */

        public function purge($options=array());

}

 

/**

class HippoFileCacheEngine implements HippoCacheEngine {