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

  • AbstractGrant
  • AuthorizationCode
  • ClientCredentials
  • GrantFactory
  • Password
  • RefreshToken
  • Overview
  • Namespace
  • Class
  • Download

Class AbstractGrant

Represents a type of authorization grant.

An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token. OAuth 2.0 defines four grant types -- authorization code, implicit, resource owner password credentials, and client credentials -- as well as an extensibility mechanism for defining additional types.

League\OAuth2\Client\Grant\AbstractGrant uses League\OAuth2\Client\Tool\RequiredParameterTrait

Direct known subclasses

League\OAuth2\Client\Grant\AuthorizationCode, League\OAuth2\Client\Grant\ClientCredentials, League\OAuth2\Client\Grant\Password, League\OAuth2\Client\Grant\RefreshToken
Abstract
Namespace: League\OAuth2\Client\Grant
Link: Authorization Grant (RFC 6749, ยง1.3)
Located at src/Grant/AbstractGrant.php
Methods summary
abstract protected string
# getName( )

Returns the name of this grant, eg. 'grant_name', which is used as the grant type when encoding URL query parameters.

Returns the name of this grant, eg. 'grant_name', which is used as the grant type when encoding URL query parameters.

Returns

string
abstract protected array
# getRequiredRequestParameters( )

Returns a list of all required request parameters.

Returns a list of all required request parameters.

Returns

array
public string
# __toString( )

Returns this grant's name as its string representation. This allows for string interpolation when building URL query parameters.

Returns this grant's name as its string representation. This allows for string interpolation when building URL query parameters.

Returns

string
public array
# prepareRequestParameters( array $defaults, array $options )

Prepares an access token request's parameters by checking that all required parameters are set, then merging with any given defaults.

Prepares an access token request's parameters by checking that all required parameters are set, then merging with any given defaults.

Parameters

$defaults
$options

Returns

array
MercadoLibre Provider for OAuth 2.0 Client API documentation generated by ApiGen