<?php
/**
 * Abstract filter object. Should be extended by all filter types
 *
 * @category Xodoa
 * @package Elastica
 * @author Nicolas Ruflin <hide@address.com>
 * @link http://www.elasticsearch.org/guide/reference/query-dsl/
 */
abstract class Elastica_Filter_Abstract extends Elastica_Param
{
    /**
     * Sets the filter cache
     *
     * @param  boolean                  $cached Cached
     * @return Elastica_Filter_Abstract
     */
    public function setCached($cached = true)
    {
        return $this->setParam('_cache', (bool) $cached);
    }

    /**
     * Sets the filter cache key
     *
     * @param  string                   $cacheKey Cache key
     * @return Elastica_Filter_Abstract
     */
    public function setCacheKey($cacheKey)
    {
        $cacheKey = (string) $cacheKey;

        if (empty($cacheKey)) {
            throw new Elastica_Exception_Invalid('Invalid parameter. Has to be a non empty string');
        }

        return $this->setParam('_cache_key', (string) $cacheKey);
    }

    /**
     * Sets the filter name
     *
     * @param  string                   $name Name
     * @return Elastica_Filter_Abstract
     */
    public function setName($name)
    {
        return $this->setParam('_name', $name);
    }
}