PHP Class LdapTools\Operation\AuthenticationOperation

Author: Chad Sikorra ([email protected])
Inheritance: implements LdapTools\Operation\LdapOperationInterface, use trait LdapOperationTrait
Show file Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property Type Description
$properties array

Public Methods

Method Description
__construct ( null | string $username = null, null | string $password = null )
getArguments ( )
getIsAnonymousBind ( ) : boolean Get whether this authentication attempt should be an anonymous bind.
getLdapFunction ( )
getLogArray ( )
getName ( )
getPassword ( ) : string | null Get the password that will be used for the authentication operation.
getSwitchToCredentials ( ) : boolean Get whether the connection should switch to be bound under the context of the credentials given by this object when this operation is executed.
getUsername ( ) : string | null Get the username that will be used in the authentication operation.
setIsAnonymousBind ( boolean $anonymous ) Set whether this authentication attempt should be an anonymous bind.
setPassword ( string $password ) Set the password that will be used for the authentication operation.
setSwitchToCredentials ( boolean $switchToCredentials ) Set whether the connection should switch to be bound under the context of the credentials given by this object when this operation is executed.
setUsername ( string $username ) Set the username that will be used in the authentication operation.

Protected Methods

Method Description
validateArguments ( ) Validates that the arguments given don't have any issues.

Method Details

__construct() public method

public __construct ( null | string $username = null, null | string $password = null )
$username null | string
$password null | string

getArguments() public method

public getArguments ( )

getIsAnonymousBind() public method

Get whether this authentication attempt should be an anonymous bind.
public getIsAnonymousBind ( ) : boolean
return boolean

getLdapFunction() public method

public getLdapFunction ( )

getLogArray() public method

public getLogArray ( )

getName() public method

public getName ( )

getPassword() public method

Get the password that will be used for the authentication operation.
public getPassword ( ) : string | null
return string | null

getSwitchToCredentials() public method

Get whether the connection should switch to be bound under the context of the credentials given by this object when this operation is executed.
public getSwitchToCredentials ( ) : boolean
return boolean

getUsername() public method

Get the username that will be used in the authentication operation.
public getUsername ( ) : string | null
return string | null

setIsAnonymousBind() public method

Set whether this authentication attempt should be an anonymous bind.
public setIsAnonymousBind ( boolean $anonymous )
$anonymous boolean

setPassword() public method

Set the password that will be used for the authentication operation.
public setPassword ( string $password )
$password string

setSwitchToCredentials() public method

Set whether the connection should switch to be bound under the context of the credentials given by this object when this operation is executed.
public setSwitchToCredentials ( boolean $switchToCredentials )
$switchToCredentials boolean

setUsername() public method

Set the username that will be used in the authentication operation.
public setUsername ( string $username )
$username string

validateArguments() protected method

Validates that the arguments given don't have any issues.
protected validateArguments ( )

Property Details

$properties protected property

protected array $properties
return array