PHP Class BookStack\Providers\LdapUserProvider

Inheritance: implements Illuminate\Contracts\Auth\UserProvider
Show file Open project: ssddanbrown/bookstack

Protected Properties

Property Type Description
$ldapService BookStack\Services\LdapService
$model string The user model.

Public Methods

Method Description
__construct ( $model, LdapService $ldapService ) LdapUserProvider constructor.
createModel ( ) : Model Create a new instance of the model.
retrieveByCredentials ( array $credentials ) : Illuminate\Contracts\Auth\Authenticatable | null Retrieve a user by the given credentials.
retrieveById ( mixed $identifier ) : Illuminate\Contracts\Auth\Authenticatable | null Retrieve a user by their unique identifier.
retrieveByToken ( mixed $identifier, string $token ) : Illuminate\Contracts\Auth\Authenticatable | null Retrieve a user by their unique identifier and "remember me" token.
updateRememberToken ( Illuminate\Contracts\Auth\Authenticatable $user, string $token ) : void Update the "remember me" token for the given user in storage.
validateCredentials ( Illuminate\Contracts\Auth\Authenticatable $user, array $credentials ) : boolean Validate a user against the given credentials.

Method Details

__construct() public method

LdapUserProvider constructor.
public __construct ( $model, LdapService $ldapService )
$model
$ldapService BookStack\Services\LdapService

createModel() public method

Create a new instance of the model.
public createModel ( ) : Model
return Illuminate\Database\Eloquent\Model

retrieveByCredentials() public method

Retrieve a user by the given credentials.
public retrieveByCredentials ( array $credentials ) : Illuminate\Contracts\Auth\Authenticatable | null
$credentials array
return Illuminate\Contracts\Auth\Authenticatable | null

retrieveById() public method

Retrieve a user by their unique identifier.
public retrieveById ( mixed $identifier ) : Illuminate\Contracts\Auth\Authenticatable | null
$identifier mixed
return Illuminate\Contracts\Auth\Authenticatable | null

retrieveByToken() public method

Retrieve a user by their unique identifier and "remember me" token.
public retrieveByToken ( mixed $identifier, string $token ) : Illuminate\Contracts\Auth\Authenticatable | null
$identifier mixed
$token string
return Illuminate\Contracts\Auth\Authenticatable | null

updateRememberToken() public method

Update the "remember me" token for the given user in storage.
public updateRememberToken ( Illuminate\Contracts\Auth\Authenticatable $user, string $token ) : void
$user Illuminate\Contracts\Auth\Authenticatable
$token string
return void

validateCredentials() public method

Validate a user against the given credentials.
public validateCredentials ( Illuminate\Contracts\Auth\Authenticatable $user, array $credentials ) : boolean
$user Illuminate\Contracts\Auth\Authenticatable
$credentials array
return boolean

Property Details

$ldapService protected property

protected LdapService,BookStack\Services $ldapService
return BookStack\Services\LdapService

$model protected property

The user model.
protected string $model
return string