XcacheCache.php

<?php

/*
 * 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
 * OWNER 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.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Cache;


/**
 * Xcache cache driver.
 *
 * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link    www.doctrine-project.org
 * @since   2.0
 * @author  Benjamin Eberlei <kontakt@beberlei.de>
 * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author  Jonathan Wage <jonwage@gmail.com>
 * @author  Roman Borschel <roman@code-factory.org>
 * @author  David Abdemoulaie <dave@hobodave.com>
 */
class XcacheCache extends CacheProvider {

  /**
   * {@inheritdoc}
   */
  protected function doFetch($id) {
    return $this
      ->doContains($id) ? unserialize(xcache_get($id)) : false;
  }

  /**
   * {@inheritdoc}
   */
  protected function doContains($id) {
    return xcache_isset($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    return xcache_set($id, serialize($data), (int) $lifeTime);
  }

  /**
   * {@inheritdoc}
   */
  protected function doDelete($id) {
    return xcache_unset($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    $this
      ->checkAuthorization();
    xcache_clear_cache(XC_TYPE_VAR, 0);
    return true;
  }

  /**
   * Checks that xcache.admin.enable_auth is Off
   *
   * @throws \BadMethodCallException When xcache.admin.enable_auth is On
   * @return void
   */
  protected function checkAuthorization() {
    if (ini_get('xcache.admin.enable_auth')) {
      throw new \BadMethodCallException('To use all features of \\Doctrine\\Common\\Cache\\XcacheCache, you must set "xcache.admin.enable_auth" to "Off" in your php.ini.');
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {
    $this
      ->checkAuthorization();
    $info = xcache_info(XC_TYPE_VAR, 0);
    return array(
      Cache::STATS_HITS => $info['hits'],
      Cache::STATS_MISSES => $info['misses'],
      Cache::STATS_UPTIME => null,
      Cache::STATS_MEMORY_USAGE => $info['size'],
      Cache::STATS_MEMORY_AVAILIABLE => $info['avail'],
    );
  }

}