PHP Interface Adldap\Connections\ProviderInterface

Show file Open project: adldap2/adldap2

Public Methods

Method Description
__construct ( DomainConfiguration | array $configuration, Adldap\Connections\ConnectionInterface $connection, Adldap\Schemas\SchemaInterface $schema = null ) Constructor.
__destruct ( ) Destructor.
auth ( ) : Guard Returns a new Auth Guard instance.
connect ( string | null $username = null, string | null $password = null ) : Adldap\Connections\ProviderInterface Connects and Binds to the Domain Controller.
getConfiguration ( ) : DomainConfiguration Returns the current configuration instance.
getConnection ( ) : Adldap\Connections\ConnectionInterface Returns the current connection instance.
getDefaultGuard ( Adldap\Connections\ConnectionInterface $connection, DomainConfiguration $configuration ) : Guard Returns a new default Guard instance.
getGuard ( ) : Guard Returns the current Guard instance.
getSchema ( ) : Adldap\Schemas\SchemaInterface Returns the current LDAP attribute schema.
make ( ) : Factory Returns a new Model factory instance.
search ( ) : Factory Returns a new Search factory instance.
setConfiguration ( DomainConfiguration | array $configuration = [] ) Sets the current configuration.
setConnection ( Adldap\Connections\ConnectionInterface $connection = null ) Sets the current connection.
setGuard ( Adldap\Auth\GuardInterface $guard ) Sets the current Guard instance.
setSchema ( Adldap\Schemas\SchemaInterface $schema = null ) Sets the current LDAP attribute schema.

Method Details

__construct() public method

Constructor.
public __construct ( DomainConfiguration | array $configuration, Adldap\Connections\ConnectionInterface $connection, Adldap\Schemas\SchemaInterface $schema = null )
$configuration Adldap\Configuration\DomainConfiguration | array
$connection Adldap\Connections\ConnectionInterface
$schema Adldap\Schemas\SchemaInterface

__destruct() public method

Closes the current LDAP connection if it exists.
public __destruct ( )

auth() public method

Returns a new Auth Guard instance.
public auth ( ) : Guard
return Adldap\Auth\Guard

connect() public method

If no username or password is specified, then the configured administrator credentials are used.
public connect ( string | null $username = null, string | null $password = null ) : Adldap\Connections\ProviderInterface
$username string | null
$password string | null
return Adldap\Connections\ProviderInterface

getConfiguration() public method

Returns the current configuration instance.
public getConfiguration ( ) : DomainConfiguration
return Adldap\Configuration\DomainConfiguration

getConnection() public method

Returns the current connection instance.
public getConnection ( ) : Adldap\Connections\ConnectionInterface
return Adldap\Connections\ConnectionInterface

getDefaultGuard() public method

Returns a new default Guard instance.
public getDefaultGuard ( Adldap\Connections\ConnectionInterface $connection, DomainConfiguration $configuration ) : Guard
$connection Adldap\Connections\ConnectionInterface
$configuration Adldap\Configuration\DomainConfiguration
return Adldap\Auth\Guard

getGuard() public method

Returns the current Guard instance.
public getGuard ( ) : Guard
return Adldap\Auth\Guard

getSchema() public method

Returns the current LDAP attribute schema.
public getSchema ( ) : Adldap\Schemas\SchemaInterface
return Adldap\Schemas\SchemaInterface

make() public method

Returns a new Model factory instance.
public make ( ) : Factory
return Adldap\Models\Factory

setConfiguration() public method

Sets the current configuration.
public setConfiguration ( DomainConfiguration | array $configuration = [] )
$configuration Adldap\Configuration\DomainConfiguration | array

setConnection() public method

Sets the current connection.
public setConnection ( Adldap\Connections\ConnectionInterface $connection = null )
$connection Adldap\Connections\ConnectionInterface

setGuard() public method

Sets the current Guard instance.
public setGuard ( Adldap\Auth\GuardInterface $guard )
$guard Adldap\Auth\GuardInterface

setSchema() public method

Sets the current LDAP attribute schema.
public setSchema ( Adldap\Schemas\SchemaInterface $schema = null )
$schema Adldap\Schemas\SchemaInterface