Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/*
4 * This file is part of the Symfony package.
5 *
6 * (c) Fabien Potencier <fabien@symfony.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
11
12namespace Symfony\Component\Ldap;
13
14use Symfony\Component\Ldap\Adapter\EntryManagerInterface;
15use Symfony\Component\Ldap\Adapter\QueryInterface;
16use Symfony\Component\Ldap\Exception\ConnectionException;
17
18/**
19 * Ldap interface.
20 *
21 * @author Charles Sarrazin <charles@sarraz.in>
22 */
23interface LdapInterface
24{
25    const ESCAPE_FILTER = 0x01;
26    const ESCAPE_DN = 0x02;
27
28    /**
29     * Return a connection bound to the ldap.
30     *
31     * @throws ConnectionException if dn / password could not be bound
32     */
33    public function bind(string $dn = null, string $password = null);
34
35    /**
36     * Queries a ldap server for entries matching the given criteria.
37     *
38     * @return QueryInterface
39     */
40    public function query(string $dn, string $query, array $options = []);
41
42    /**
43     * @return EntryManagerInterface
44     */
45    public function getEntryManager();
46
47    /**
48     * Escape a string for use in an LDAP filter or DN.
49     *
50     * @return string
51     */
52    public function escape(string $subject, string $ignore = '', int $flags = 0);
53}