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

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

Class GrantFactory

Represents a factory used when retrieving an authorization grant type.

Namespace: League\OAuth2\Client\Grant
Located at src/Grant/GrantFactory.php
Methods summary
public League\OAuth2\Client\Grant\GrantFactory
# setGrant( string $name, League\OAuth2\Client\Grant\AbstractGrant $grant )

Defines a grant singleton in the registry.

Defines a grant singleton in the registry.

Parameters

$name
$grant

Returns

League\OAuth2\Client\Grant\GrantFactory
public League\OAuth2\Client\Grant\AbstractGrant
# getGrant( string $name )

Returns a grant singleton by name.

Returns a grant singleton by name.

If the grant has not be registered, a default grant will be loaded.

Parameters

$name

Returns

League\OAuth2\Client\Grant\AbstractGrant
protected League\OAuth2\Client\Grant\GrantFactory
# registerDefaultGrant( string $name )

Registers a default grant singleton by name.

Registers a default grant singleton by name.

Parameters

$name

Returns

League\OAuth2\Client\Grant\GrantFactory
public boolean
# isGrant( mixed $class )

Determines if a variable is a valid grant.

Determines if a variable is a valid grant.

Parameters

$class

Returns

boolean
public
# checkGrant( mixed $class )

Checks if a variable is a valid grant.

Checks if a variable is a valid grant.

Parameters

$class

Throws

League\OAuth2\Client\Grant\Exception\InvalidGrantException
Properties summary
protected array $registry
# []
MercadoLibre PHP SDK API documentation generated by ApiGen