symfony/src/Symfony/Component/Ldap/Adapter/QueryInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Component\Ldap\Adapter;

use Symfony\Component\Ldap\Entry;
use Symfony\Component\Ldap\Exception\LdapException;
use Symfony\Component\Ldap\Exception\NotBoundException;

/**
 * @author Charles Sarrazin <charles@sarraz.in>
 * @author Bob van de Vijver <bobvandevijver@hotmail.com>
 */
interface QueryInterface
{
    const DEREF_NEVER = 0x00;
    const DEREF_SEARCHING = 0x01;
    const DEREF_FINDING = 0x02;
    const DEREF_ALWAYS = 0x03;

    const SCOPE_BASE = 'base';
    const SCOPE_ONE = 'one';
    const SCOPE_SUB = 'sub';

    /**
     * Executes a query and returns the list of Ldap entries.
     *
     * @return CollectionInterface|Entry[]
     *
     * @throws NotBoundException
     * @throws LdapException
     */
    public function execute();
}