PHP Class Adldap\Connections\Provider

Inheritance: implements Adldap\Connections\ProviderInterface

Show file Open project: adldap2/adldap2 Class Usage Examples

Protected Properties

Property	Type	Description
$configuration	Adldap\Configuration\DomainConfiguration	The providers configuration.
$connection	Adldap\Connections\ConnectionInterface	The providers connection.
$guard	Adldap\Auth\GuardInterface	The providers auth guard instance.
$schema	Adldap\Schemas\SchemaInterface	The providers schema.

Public Methods

Method	Description
__construct ( $configuration = [], Adldap\Connections\ConnectionInterface $connection = null, Adldap\Schemas\SchemaInterface $schema = null )
__destruct ( )
auth ( )
connect ( $username = null, $password = null )
getConfiguration ( )
getConnection ( )
getDefaultGuard ( Adldap\Connections\ConnectionInterface $connection, DomainConfiguration $configuration )
getGuard ( )
getSchema ( )
make ( )
search ( )
setConfiguration ( $configuration = [] )
setConnection ( Adldap\Connections\ConnectionInterface $connection = null )
setGuard ( Adldap\Auth\GuardInterface $guard )
setSchema ( Adldap\Schemas\SchemaInterface $schema = null )

Protected Methods

Method	Description
newModelFactory ( Builder $builder, Adldap\Schemas\SchemaInterface $schema ) : Factory	Creates a new model factory.
newSearchFactory ( Adldap\Connections\ConnectionInterface $connection, Adldap\Schemas\SchemaInterface $schema, string $baseDn ) : Factory	Creates a new search factory.
prepareConnection ( ) : void	Prepares the connection by setting configured parameters.

Method Details

__construct() public method

public __construct ( $configuration = [], Adldap\Connections\ConnectionInterface $connection = null, Adldap\Schemas\SchemaInterface $schema = null )
$connection	Adldap\Connections\ConnectionInterface
$schema	Adldap\Schemas\SchemaInterface

__destruct() public method

public __destruct ( )

auth() public method

public auth ( )

connect() public method

public connect ( $username = null, $password = null )

getConfiguration() public method

public getConfiguration ( )

getConnection() public method

public getConnection ( )

getDefaultGuard() public method

public getDefaultGuard ( Adldap\Connections\ConnectionInterface $connection, DomainConfiguration $configuration )
$connection	Adldap\Connections\ConnectionInterface
$configuration	Adldap\Configuration\DomainConfiguration

getGuard() public method

public getGuard ( )

getSchema() public method

public getSchema ( )

make() public method

public make ( )

newModelFactory() protected method

Creates a new model factory.

protected newModelFactory ( Builder $builder, Adldap\Schemas\SchemaInterface $schema ) : Factory
$builder	Adldap\Query\Builder
$schema	Adldap\Schemas\SchemaInterface
return	Adldap\Models\Factory

newSearchFactory() protected method

Creates a new search factory.

protected newSearchFactory ( Adldap\Connections\ConnectionInterface $connection, Adldap\Schemas\SchemaInterface $schema, string $baseDn ) : Factory
$connection	Adldap\Connections\ConnectionInterface
$schema	Adldap\Schemas\SchemaInterface
$baseDn	string
return	Adldap\Search\Factory

prepareConnection() protected method

Prepares the connection by setting configured parameters.

protected prepareConnection ( ) : void
return	void

search() public method

public search ( )

setConfiguration() public method

public setConfiguration ( $configuration = [] )

setConnection() public method

public setConnection ( Adldap\Connections\ConnectionInterface $connection = null )
$connection	Adldap\Connections\ConnectionInterface

setGuard() public method

public setGuard ( Adldap\Auth\GuardInterface $guard )
$guard	Adldap\Auth\GuardInterface

setSchema() public method

public setSchema ( Adldap\Schemas\SchemaInterface $schema = null )
$schema	Adldap\Schemas\SchemaInterface

Property Details

$configuration protected property

The providers configuration.

protected DomainConfiguration,Adldap\Configuration $configuration
return	Adldap\Configuration\DomainConfiguration

$connection protected property

The providers connection.

protected ConnectionInterface,Adldap\Connections $connection
return	Adldap\Connections\ConnectionInterface

$guard protected property

The providers auth guard instance.

protected GuardInterface,Adldap\Auth $guard
return	Adldap\Auth\GuardInterface

$schema protected property

The providers schema.

protected SchemaInterface,Adldap\Schemas $schema
return	Adldap\Schemas\SchemaInterface