ApcCache.php

<?php
/**
 * Simple Abstraction Class to APC.
 *
 * The Alternative PHP Cache (APC) is a free and open opcode cache for PHP.
 * Its goal is to provide a free, open, and robust framework for caching and
 * optimizing PHP intermediate code.
 *
 * @see http://www.php.net/manual/en/book.apc.php
 *
 * Copyright (c) 2010 Richard Castera
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
namespace rcastera\Apc;

class ApcCache {
    /**
     * Retrieves cached information from APC's data store.
     *
     * @param string $type - If $type is "user", information about the user cache will be returned.
     * @param boolean $limited - If $limited is true, the return value will exclude the individual
     *                           list of cache entries. This is useful when trying to optimize calls
     *                           for statistics gathering.
     *
     * @return array of cached data (and meta-data) or false on failure.
     */
    public static function info($type = '', $limited = false)
    {
        try {
            return apc_cache_info($type, $limited);
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Checks if APC key exists.
     *
     * @param mixed $key - A string, or an array of strings, that contain keys.
     *
     * @return mixed - Returns true if the key exists, otherwise false or if an
     *                 array was passed to keys, then an array is returned that
     *                 contains all existing keys, or an empty array if none exist.
     */
    public static function exists($key = '')
    {
        try {
            return apc_exists($key);
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Cache a variable in the data store.
     *
     * @param string $key - Store the variable using this name.
     * @param string $data - The variable to store.
     * @param string $ttl - Time To Live; store var in the cache for ttl seconds.
     *
     * @return boolean - Returns true on success or false on failure.
    */
    public static function store($key, $data, $ttl = 0, $overwrite = false)
    {
        try {
            if ($overwrite) {
                return apc_store($key, $data, $ttl);
            } else {
                return apc_add($key, $data, $ttl);
            }
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Fetch stored value in APC from key.
     *
     * @param string $key - The key used to store the value.
     *
     * @return boolean - The stored variable or array of variables on success; false on failure.
     */
    public static function fetch($key = '')
    {
        try {
            if (self::exists($key)) {
                return apc_fetch($key);
            } else {
                return false;
            }
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Removes a stored variable from the cache.
     *
     * @param string $key - The key used to store the value (with apc_store()).
     *
     * @return boolean - Returns true on success or false on failure.
     */
    public static function delete($key = '')
    {
        try {
            return apc_delete($key);
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Clears the APC cache.
     *
     * @param string $type - If $type is "user", the user cache will be cleared; otherwise,
     *                       the system cache (cached files) will be cleared.
     *
     * @return boolean - Returns true on success or false on failure.
     */
    public static function clear($type = '') {
        try {
            return apc_clear_cache($type);
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
    }
}