PHP Class Chrisbjr\ApiGuard\ApiGuardAuth

Show file Open project: chrisbjr/api-guard

Protected Properties

Property Type Description
$auth

Public Methods

Method Description
__construct ( Chrisbjr\ApiGuard\Contracts\Providers\Auth $auth )
authenticate ( ApiKeyRepository $apiKey ) : boolean | mixed Authenticate a user via the API key.
getUser ( ) Get the authenticated user.
isAuthenticated ( ) : boolean Determines if we have an authenticated user

Method Details

__construct() public method

public __construct ( Chrisbjr\ApiGuard\Contracts\Providers\Auth $auth )
$auth Chrisbjr\ApiGuard\Contracts\Providers\Auth

authenticate() public method

Authenticate a user via the API key.
public authenticate ( ApiKeyRepository $apiKey ) : boolean | mixed
$apiKey Chrisbjr\ApiGuard\Repositories\ApiKeyRepository
return boolean | mixed

getUser() public method

Get the authenticated user.
public getUser ( )

isAuthenticated() public method

Determines if we have an authenticated user
public isAuthenticated ( ) : boolean
return boolean

Property Details

$auth protected property

protected $auth