\Pop\Auth\AdapterLdap

Ldap auth adapter class

Summary

Methods
Properties
Constants
getUsername()
getPassword()
setUsername()
setPassword()
authenticate()
__construct()
setHost()
setPort()
setOption()
setOptions()
getHost()
getPort()
getOption()
getOptions()
resource()
No public properties found
No constants found
No protected methods found
$username
$password
$host
$port
$options
$resource
N/A
No private methods found
No private properties found
N/A

Properties

$username

$username : string

Username to authenticate against

Type

string

$password

$password : string

Password to authenticate against

Type

string

$host

$host : string

Ldap host

Type

string

$port

$port : string

Ldap port

Type

string

$options

$options : array

Ldap options

Type

array

$resource

$resource : resource

Ldap resource

Type

resource

Methods

getUsername()

getUsername() : string

Get the username

Returns

string

getPassword()

getPassword() : string

Get the password

Returns

string

setUsername()

setUsername(string  $username) : \Pop\Auth\Adapter\AbstractAdapter

Set the username

Parameters

string $username

Returns

\Pop\Auth\Adapter\AbstractAdapter

setPassword()

setPassword(string  $password) : \Pop\Auth\Adapter\AbstractAdapter

Set the password

Parameters

string $password

Returns

\Pop\Auth\Adapter\AbstractAdapter

authenticate()

authenticate() : integer

Method to authenticate

Returns

integer

__construct()

__construct(string  $host, string  $port = null, array  $options = null) : \Pop\Auth\Adapter\Ldap

Constructor

Instantiate the Ldap auth adapter object

Parameters

string $host
string $port
array $options

Returns

\Pop\Auth\Adapter\Ldap

setHost()

setHost(string  $host) : \Pop\Auth\Adapter\Ldap

Set the host

Parameters

string $host

Returns

\Pop\Auth\Adapter\Ldap

setPort()

setPort(string  $port) : \Pop\Auth\Adapter\Ldap

Set the port

Parameters

string $port

Returns

\Pop\Auth\Adapter\Ldap

setOption()

setOption(mixed  $option, mixed  $value) : \Pop\Auth\Adapter\Ldap

Set an option

Parameters

mixed $option
mixed $value

Returns

\Pop\Auth\Adapter\Ldap

setOptions()

setOptions(array  $options) : \Pop\Auth\Adapter\Ldap

Set options

Parameters

array $options

Returns

\Pop\Auth\Adapter\Ldap

getHost()

getHost() : string

Get the host

Returns

string

getPort()

getPort() : string

Get the port

Returns

string

getOption()

getOption(mixed  $option) : mixed

Get an option

Parameters

mixed $option

Returns

mixed

getOptions()

getOptions() : array

Get options

Returns

array

resource()

resource() : resource

Get the Ldap resource

Returns

resource