PHP Interface Adldap\AdldapInterface

Datei anzeigen Open project: adldap2/adldap2

Public Methods

Method Description
__call ( string $method, array $parameters ) : mixed Call methods upon the default provider dynamically.
addProvider ( Adldap\Connections\ProviderInterface | array $configuration = [], string $name, Adldap\Connections\ConnectionInterface $connection = null, Adldap\Schemas\SchemaInterface $schema = null ) : adldap\AdldapInterface Add a provider by the specified name.
connect ( string | null $name = null, string | null $username = null, string | null $password = null ) : Adldap\Connections\ProviderInterface Connects to the specified provider.
getDefaultProvider ( ) : Adldap\Connections\ProviderInterface Retrieves the first provider.
getProvider ( string $name ) : Adldap\Connections\ProviderInterface Retrieves a Provider using it's specified name.
getProviders ( ) : array Returns all of the connection providers.
removeProvider ( string $name ) : adldap\AdldapInterface Removes a provider by the specified name.
setDefaultProvider ( string $name ) Sets the default provider.

Method Details

__call() public method

Call methods upon the default provider dynamically.
public __call ( string $method, array $parameters ) : mixed
$method string
$parameters array
return mixed

addProvider() public method

Add a provider by the specified name.
public addProvider ( Adldap\Connections\ProviderInterface | array $configuration = [], string $name, Adldap\Connections\ConnectionInterface $connection = null, Adldap\Schemas\SchemaInterface $schema = null ) : adldap\AdldapInterface
$configuration Adldap\Connections\ProviderInterface | array
$name string
$connection Adldap\Connections\ConnectionInterface
$schema Adldap\Schemas\SchemaInterface
return adldap\AdldapInterface

connect() public method

If no username and password is given, then providers configured admin credentials are used.
public connect ( string | null $name = null, string | null $username = null, string | null $password = null ) : Adldap\Connections\ProviderInterface
$name string | null
$username string | null
$password string | null
return Adldap\Connections\ProviderInterface

getDefaultProvider() public method

Retrieves the first provider.
public getDefaultProvider ( ) : Adldap\Connections\ProviderInterface
return Adldap\Connections\ProviderInterface

getProvider() public method

Retrieves a Provider using it's specified name.
public getProvider ( string $name ) : Adldap\Connections\ProviderInterface
$name string
return Adldap\Connections\ProviderInterface

getProviders() public method

Returns all of the connection providers.
public getProviders ( ) : array
return array

removeProvider() public method

Removes a provider by the specified name.
public removeProvider ( string $name ) : adldap\AdldapInterface
$name string
return adldap\AdldapInterface

setDefaultProvider() public method

Sets the default provider.
public setDefaultProvider ( string $name )
$name string