PHP Class KnpU\OAuth2ClientBundle\Client\OAuth2Client

Show file Open project: knpuniversity/oauth2-client-bundle Class Usage Examples

Public Methods

Method Description
__construct ( League\OAuth2\Client\Provider\AbstractProvider $provider, Symfony\Component\HttpFoundation\RequestStack $requestStack ) OAuth2Client constructor.
fetchUser ( ) : League\OAuth2\Client\Provider\ResourceOwnerInterface Shortcut to fetch the access token and user all at once.
fetchUserFromToken ( League\OAuth2\Client\Token\AccessToken $accessToken ) : League\OAuth2\Client\Provider\ResourceOwnerInterface Returns the "User" information (called a resource owner).
getAccessToken ( ) : League\OAuth2\Client\Token\AccessToken Call this after the user is redirected back to get the access token.
getOAuth2Provider ( ) : League\OAuth2\Client\Provider\AbstractProvider Returns the underlying OAuth2 provider.
redirect ( array $scopes = [] ) : RedirectResponse Creates a RedirectResponse that will send the user to the OAuth2 server (e.g. send them to Facebook).
setAsStateless ( ) Call this to avoid using and checking "state".

Private Methods

Method Description
getCurrentRequest ( ) : Request
getSession ( ) : null | Symfony\Component\HttpFoundation\Session\SessionInterface

Method Details

__construct() public method

OAuth2Client constructor.
public __construct ( League\OAuth2\Client\Provider\AbstractProvider $provider, Symfony\Component\HttpFoundation\RequestStack $requestStack )
$provider League\OAuth2\Client\Provider\AbstractProvider
$requestStack Symfony\Component\HttpFoundation\RequestStack

fetchUser() public method

Only use this if you don't need the access token, but only need the user.
public fetchUser ( ) : League\OAuth2\Client\Provider\ResourceOwnerInterface
return League\OAuth2\Client\Provider\ResourceOwnerInterface

fetchUserFromToken() public method

Returns the "User" information (called a resource owner).
public fetchUserFromToken ( League\OAuth2\Client\Token\AccessToken $accessToken ) : League\OAuth2\Client\Provider\ResourceOwnerInterface
$accessToken League\OAuth2\Client\Token\AccessToken
return League\OAuth2\Client\Provider\ResourceOwnerInterface

getAccessToken() public method

Call this after the user is redirected back to get the access token.
public getAccessToken ( ) : League\OAuth2\Client\Token\AccessToken
return League\OAuth2\Client\Token\AccessToken

getOAuth2Provider() public method

Returns the underlying OAuth2 provider.
public getOAuth2Provider ( ) : League\OAuth2\Client\Provider\AbstractProvider
return League\OAuth2\Client\Provider\AbstractProvider

redirect() public method

Creates a RedirectResponse that will send the user to the OAuth2 server (e.g. send them to Facebook).
public redirect ( array $scopes = [] ) : RedirectResponse
$scopes array The scopes you want (leave empty to use default)
return Symfony\Component\HttpFoundation\RedirectResponse

setAsStateless() public method

Call this to avoid using and checking "state".
public setAsStateless ( )