54 lines
1.3 KiB
PHP
54 lines
1.3 KiB
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;
|
|
|
|
use Symfony\Component\Ldap\Adapter\EntryManagerInterface;
|
|
use Symfony\Component\Ldap\Adapter\QueryInterface;
|
|
use Symfony\Component\Ldap\Exception\ConnectionException;
|
|
|
|
/**
|
|
* Ldap interface.
|
|
*
|
|
* @author Charles Sarrazin <charles@sarraz.in>
|
|
*/
|
|
interface LdapInterface
|
|
{
|
|
const ESCAPE_FILTER = 0x01;
|
|
const ESCAPE_DN = 0x02;
|
|
|
|
/**
|
|
* Return a connection bound to the ldap.
|
|
*
|
|
* @throws ConnectionException if dn / password could not be bound
|
|
*/
|
|
public function bind(string $dn = null, string $password = null);
|
|
|
|
/**
|
|
* Queries a ldap server for entries matching the given criteria.
|
|
*
|
|
* @return QueryInterface
|
|
*/
|
|
public function query(string $dn, string $query, array $options = []);
|
|
|
|
/**
|
|
* @return EntryManagerInterface
|
|
*/
|
|
public function getEntryManager();
|
|
|
|
/**
|
|
* Escape a string for use in an LDAP filter or DN.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function escape(string $subject, string $ignore = '', int $flags = 0);
|
|
}
|