<?php

/*
 * This file is part of the Sonata package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Filter;

use Symfony\Component\Form\FormFactory;

interface FilterInterface
{
    /**
     * Apply the filter to the QueryBuilder instance
     *
     * @abstract
     * @param  $queryBuilder
     * @param string $alias
     * @param string $field
     * @param string $value
     * @return void
     */
    function filter($queryBuilder, $alias, $field, $value);

    /**
     * Define the related field builder
     *
     * @abstract
     * @param \Symfony\Component\Form\FormFactory
     * @return void
     */
    function defineFieldBuilder(FormFactory $formFactory);

    /**
     * Returns the filter name
     * @abstract
     * @return string
     */
    function getName();

    /**
     * Returns the formBuilder instance
     *
     * @abstract
     * @return \Symfony\Component\Form\FormBuilder
     */
    function getField();

    /**
     * @abstract
     * @return array
     */
    function getDefaultOptions();

    /**
     * @abstract
     * @param string $name
     * @param null $default
     * @return void
     */
    function getOption($name, $default = null);

    /**
     * @abstract
     * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
     */
    function getFieldDescription();

}