<?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\ORM\Cache;

use Doctrine\ORM\Query\ResultSetMapping;

/**
 * Defines the contract for caches capable of storing query results.
 * These caches should only concern themselves with storing the matching result ids.
 *
 * @since   2.5
 * @author  Fabio B. Silva <fabio.bat.silva@gmail.com>
 */
interface QueryCache
{
    /**
     * @return boolean
     */
    public function clear();

    /**
     * @param \Doctrine\ORM\Cache\QueryCacheKey    $key
     * @param \Doctrine\ORM\Query\ResultSetMapping $rsm
     * @param mixed                                $result
     * @param array                                $hints
     *
     * @return boolean
     */
    public function put(QueryCacheKey $key, ResultSetMapping $rsm, $result, array $hints = array());

    /**
     * @param \Doctrine\ORM\Cache\QueryCacheKey     $key
     * @param \Doctrine\ORM\Query\ResultSetMapping  $rsm
     * @param array                                 $hints
     *
     * @return array|null
     */
    public function get(QueryCacheKey $key, ResultSetMapping $rsm, array $hints = array());

    /**
     * @return \Doctrine\ORM\Cache\Region
     */
    public function getRegion();
}
