PHP Class Chrisbjr\ApiGuard\Providers\Auth\Sentinel

Inheritance: implements Chrisbjr\ApiGuard\Contracts\Providers\Auth

Show file Open project: chrisbjr/api-guard

Protected Properties

Property	Type	Description
$sentinel	Cartalyst\Sentinel\Sentinel

Public Methods

Method	Description
__construct ( Sentinel $sentinel )
byCredentials ( array $credentials ) : mixed	Check a user's credentials.
byId ( mixed $id ) : boolean	Authenticate a user via the id.
user ( ) : Cartalyst\Sentinel\Users\UserInterface	Get the currently authenticated user.

Method Details

__construct() public method

public __construct ( Sentinel $sentinel )
$sentinel	Cartalyst\Sentinel\Sentinel

byCredentials() public method

Check a user's credentials.

public byCredentials ( array $credentials ) : mixed
$credentials	array
return	mixed

byId() public method

Authenticate a user via the id.

public byId ( mixed $id ) : boolean
$id	mixed
return	boolean

user() public method

Get the currently authenticated user.

public user ( ) : Cartalyst\Sentinel\Users\UserInterface
return	Cartalyst\Sentinel\Users\UserInterface

Property Details

$sentinel protected property

protected Sentinel,Cartalyst\Sentinel $sentinel
return	Cartalyst\Sentinel\Sentinel