Overview

Namespaces

  • Docta
    • MercadoLibre
      • OAuth2
        • Client
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
    • Psr7
  • League
    • OAuth2
      • Client
        • Grant
          • Exception
        • Provider
          • Exception
        • Token
        • Tool
  • Psr
    • Http
      • Message

Classes

  • Provider
  • ResourceGeneric
  • ResourceOwner
  • Overview
  • Namespace
  • Class
  • Download

Class Provider

Represents a service provider.

League\OAuth2\Client\Provider\AbstractProvider uses League\OAuth2\Client\Tool\ArrayAccessorTrait, League\OAuth2\Client\Tool\QueryBuilderTrait
Extended by Docta\MercadoLibre\OAuth2\Client\Provider uses League\OAuth2\Client\Tool\BearerAuthorizationTrait
Namespace: Docta\MercadoLibre\OAuth2\Client
Located at Provider.php
Methods summary
public
# __construct( array $options = [], array $collaborators = [] )

Constructor.

Constructor.

Parameters

$options
$collaborators

Overrides

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

Returns all options that are required.

Returns all options that are required.

Returns

array
public string
# getAuthorizationUrl( array $options = [] )

Builds the authorization URL.

Builds the authorization URL.

Parameters

$options

Returns

string
The authorization URL

Overrides

League\OAuth2\Client\Provider\AbstractProvider::getAuthorizationUrl()
public string
# getApiUrl( string $path = '/', array $query = [] )

Build and returns the URL for API requests.

Build and returns the URL for API requests.

Parameters

$path
$query

Returns

string
public string
# getBaseAuthorizationUrl( )

Returns the base URL for authorizing a client.

Returns the base URL for authorizing a client.

Returns

string
public string
# getBaseAccessTokenUrl( array $params = null )

Returns the base URL for requesting an access token.

Returns the base URL for requesting an access token.

Parameters

$params

Returns

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

Returns the URL for requesting the resource owner's details.

Returns the URL for requesting the resource owner's details.

Parameters

$token

Returns

string
public null
# getDefaultScopes( )

Returns the default scopes used by this provider.

Returns the default scopes used by this provider.

Returns

null
protected string
# getAccessTokenResourceOwnerId( )

Returns the key used in the access token response to identify the resource owner.

Returns the key used in the access token response to identify the resource owner.

Returns

string
Resource owner identifier key

Overrides

League\OAuth2\Client\Provider\AbstractProvider::getAccessTokenResourceOwnerId()
public Psr\Http\Message\RequestInterface
# getAuthenticatedRequest( string $method, string $url, League\OAuth2\Client\Token\AccessToken|string $token, array $options = [] )

Returns an authenticated PSR-7 request instance.

Returns an authenticated PSR-7 request instance.

Parameters

$method
$url
$token
$options
Any of headers, body, and protocolVersion.

Returns

Psr\Http\Message\RequestInterface

Overrides

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

Checks a provider response for errors.

Checks a provider response for errors.

Parameters

$response
$data
Parsed response data

Throws

League\OAuth2\Client\Provider\Exception\IdentityProviderException
protected Docta\MercadoLibre\OAuth2\Client\ResourceOwner
# createResourceOwner( array $response, League\OAuth2\Client\Token\AccessToken $token )

Generates a resource owner object from a successful resource owner details request.

Generates a resource owner object from a successful resource owner details request.

Parameters

$response
$token

Returns

Docta\MercadoLibre\OAuth2\Client\ResourceOwner
Methods inherited from League\OAuth2\Client\Provider\AbstractProvider
appendQuery(), authorize(), createAccessToken(), createRequest(), fetchResourceOwnerDetails(), getAccessToken(), getAccessTokenBody(), getAccessTokenMethod(), getAccessTokenOptions(), getAccessTokenQuery(), getAccessTokenRequest(), getAccessTokenUrl(), getAllowedClientOptions(), getAuthorizationHeaders(), getAuthorizationParameters(), getAuthorizationQuery(), getContentType(), getDefaultHeaders(), getGrantFactory(), getHeaders(), getHttpClient(), getParsedResponse(), getRandomState(), getRequest(), getRequestFactory(), getResourceOwner(), getResponse(), getScopeSeparator(), 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 summary
protected string $apiUrl
# 'https://api.mercadolibre.com'
protected array $authSites
# [ 'MLA' => 'https://auth.mercadolibre.com.ar', 'MLB' => 'https://auth.mercadolivre.com.br', 'MCO' => 'https://auth.mercadolibre.com.co', 'MCR' => 'https://auth.mercadolibre.com.cr', 'MEC' => 'https://auth.mercadolibre.com.ec', 'MLC' => 'https://auth.mercadolibre.cl', 'MLM' => 'https://auth.mercadolibre.com.mx', 'MLU' => 'https://auth.mercadolibre.com.uy', 'MLV' => 'https://auth.mercadolibre.com.ve', 'MPA' => 'https://auth.mercadolibre.com.pa', 'MPE' => 'https://auth.mercadolibre.com.pe', 'MPT' => 'https://auth.mercadolibre.com.pt', 'MRD' => 'https://auth.mercadolibre.com.do' ]
protected string $authSite
#
protected string $authUrl
#
Properties inherited from League\OAuth2\Client\Provider\AbstractProvider
$clientId, $clientSecret, $grantFactory, $httpClient, $redirectUri, $requestFactory, $state
MercadoLibre Provider for OAuth 2.0 Client API documentation generated by ApiGen