AbstractCache.php

Ir para a documentação deste ficheiro.

<?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 LGPL. For more information, see
 * <http://www.doctrine-project.org>.
 */
 
namespace Doctrine\Common\Cache;
 
abstract class AbstractCache implements Cache
{
    private $_cacheIdsIndexId = 'doctrine_cache_ids';
 
    private $_namespace = null;
 
    public function setNamespace($namespace)
    {
        $this->_namespace = $namespace;
    }
 
    public function fetch($id)
    {
        return $this->_doFetch($this->_getNamespacedId($id));
    }
 
    public function contains($id)
    {
        return $this->_doContains($this->_getNamespacedId($id));
    }
 
    public function save($id, $data, $lifeTime = 0)
    {
        return $this->_doSave($this->_getNamespacedId($id), $data, $lifeTime);
    }
 
    public function delete($id)
    {
        $id = $this->_getNamespacedId($id);
 
        if (strpos($id, '*') !== false) {
            return $this->deleteByRegex('/' . str_replace('*', '.*', $id) . '/');
        }
 
        return $this->_doDelete($id);
    }
 
    public function deleteAll()
    {
        $ids = $this->getIds();
 
        foreach ($ids as $id) {
            $this->delete($id);
        }
 
        return $ids;
    }
 
    public function deleteByRegex($regex)
    {
        $deleted = array();
 
        $ids = $this->getIds();
 
        foreach ($ids as $id) {
            if (preg_match($regex, $id)) {
                $this->delete($id);
                $deleted[] = $id;
            }
        }
 
        return $deleted;
    }
 
    public function deleteByPrefix($prefix)
    {
        $deleted = array();
 
        $prefix = $this->_getNamespacedId($prefix);
        $ids = $this->getIds();
 
        foreach ($ids as $id) {
            if (strpos($id, $prefix) === 0) {
                $this->delete($id);
                $deleted[] = $id;
            }
        }
 
        return $deleted;
    }
 
    public function deleteBySuffix($suffix)
    {
        $deleted = array();
 
        $ids = $this->getIds();
 
        foreach ($ids as $id) {
            if (substr($id, -1 * strlen($suffix)) === $suffix) {
                $this->delete($id);
                $deleted[] = $id;
            }
        }
 
        return $deleted;
    }
 
    private function _getNamespacedId($id)
    {
        if ( ! $this->_namespace || strpos($id, $this->_namespace) === 0) {
            return $id;
        } else {
            return $this->_namespace . $id;
        }
    }
 
    abstract protected function _doFetch($id);
 
    abstract protected function _doContains($id);
 
    abstract protected function _doSave($id, $data, $lifeTime = false);
 
    abstract protected function _doDelete($id);
 
    abstract public function getIds();
}