Overview

Namespaces

  • Docta
    • MercadoLibre
      • Exception
      • OAuth2
        • Client
          • Test
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
      • Test
      • Tests
    • Psr7
    • Test
      • Handler
    • Tests
      • CookieJar
      • Event
      • Exception
      • Handler
      • Promise
      • Psr7
  • League
    • OAuth2
      • Client
        • Grant
          • Exception
        • Provider
          • Exception
        • Test
          • Grant
          • Provider
            • Exception
            • Fake
          • Token
          • Tool
        • Token
        • Tool
  • None
  • Psr
    • Http
      • Message

Classes

  • AbstractProvider
  • GenericProvider
  • GenericResourceOwner

Interfaces

  • ResourceOwnerInterface
  • Overview
  • Namespace
  • Class
  • Download

Class GenericProvider

Represents a generic service provider that may be used to interact with any OAuth 2.0 service provider, using Bearer token authentication.

League\OAuth2\Client\Provider\AbstractProvider uses League\OAuth2\Client\Tool\ArrayAccessorTrait, League\OAuth2\Client\Tool\QueryBuilderTrait
Extended by League\OAuth2\Client\Provider\GenericProvider uses League\OAuth2\Client\Tool\BearerAuthorizationTrait

Direct known subclasses

League\OAuth2\Client\Test\Provider\Generic
Namespace: League\OAuth2\Client\Provider
Located at src/Provider/GenericProvider.php
Methods summary
public
# __construct( array $options = [], array $collaborators = [] )

Parameters

$options
$collaborators

Overrides

League\OAuth2\Client\Provider\AbstractProvider::__construct()
protected array
# getConfigurableOptions( )

Returns all options that can be configured.

Returns all options that can be configured.

Returns

array
protected array
# getRequiredOptions( )

Returns all options that are required.

Returns all options that are required.

Returns

array
public string
# getBaseAuthorizationUrl( )

Returns

string

Inheritdoc

public string
# getBaseAccessTokenUrl( array $params )

Parameters

$params

Returns

string

Inheritdoc

public string
# getResourceOwnerDetailsUrl( League\OAuth2\Client\Token\AccessToken $token )

Parameters

$token

Returns

string

Inheritdoc

public array
# getDefaultScopes( )

Returns

array

Inheritdoc

protected string
# getAccessTokenMethod( )

Returns

string
HTTP method

Inheritdoc

Overrides

League\OAuth2\Client\Provider\AbstractProvider::getAccessTokenMethod()
protected string|null
# getAccessTokenResourceOwnerId( )

Returns

string|null
Resource owner identifier key

Inheritdoc

Overrides

League\OAuth2\Client\Provider\AbstractProvider::getAccessTokenResourceOwnerId()
protected string
# getScopeSeparator( )

Returns

string
Scope separator, defaults to ','

Inheritdoc

Overrides

League\OAuth2\Client\Provider\AbstractProvider::getScopeSeparator()
protected
# checkResponse( Psr\Http\Message\ResponseInterface $response, array|string $data )

Parameters

$response
$data
Parsed response data

Throws

League\OAuth2\Client\Provider\Exception\IdentityProviderException

Inheritdoc

protected League\OAuth2\Client\Provider\ResourceOwnerInterface
# createResourceOwner( array $response, League\OAuth2\Client\Token\AccessToken $token )

Parameters

$response
$token

Returns

League\OAuth2\Client\Provider\ResourceOwnerInterface

Inheritdoc

Methods inherited from League\OAuth2\Client\Provider\AbstractProvider
appendQuery(), authorize(), createAccessToken(), createRequest(), fetchResourceOwnerDetails(), getAccessToken(), getAccessTokenBody(), getAccessTokenOptions(), getAccessTokenQuery(), getAccessTokenRequest(), getAccessTokenUrl(), getAllowedClientOptions(), getAuthenticatedRequest(), getAuthorizationHeaders(), getAuthorizationParameters(), getAuthorizationQuery(), getAuthorizationUrl(), getContentType(), getDefaultHeaders(), getGrantFactory(), getHeaders(), getHttpClient(), getParsedResponse(), getRandomState(), getRequest(), getRequestFactory(), getResourceOwner(), getResponse(), getState(), parseJson(), parseResponse(), prepareAccessTokenResponse(), setGrantFactory(), setHttpClient(), setRequestFactory(), verifyGrant()
Methods used from League\OAuth2\Client\Tool\BearerAuthorizationTrait
getAuthorizationHeaders()
Methods used from League\OAuth2\Client\Tool\QueryBuilderTrait
buildQueryString()
Constants inherited from League\OAuth2\Client\Provider\AbstractProvider
ACCESS_TOKEN_RESOURCE_OWNER_ID, METHOD_GET, METHOD_POST
Properties inherited from League\OAuth2\Client\Provider\AbstractProvider
$clientId, $clientSecret, $grantFactory, $httpClient, $redirectUri, $requestFactory, $state
MercadoLibre PHP SDK API documentation generated by ApiGen