[ Index ]

PHP Cross Reference of phpBB-3.3.5-deutsch

title

Body

[close]

/vendor/lusitanian/oauth/src/OAuth/ -> ServiceFactory.php (summary)

OAuth service factory.

Author: David Desberg <david@daviddesberg.com>
Author: Pieter Hordijk <info@pieterhordijk.com>
Copyright: Copyright (c) 2013 The authors
License: http://www.opensource.org/licenses/mit-license.html MIT License
File Size: 240 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ServiceFactory:: (7 methods):
  setHttpClient()
  registerService()
  createService()
  getFullyQualifiedServiceName()
  buildV2Service()
  resolveScopes()
  buildV1Service()


Class: ServiceFactory  - X-Ref

setHttpClient(ClientInterface $httpClient)   X-Ref

param: ClientInterface $httpClient
return: ServiceFactory

registerService($serviceName, $className)   X-Ref
Register a custom service to classname mapping.

param: string $serviceName Name of the service
param: string $className   Class to instantiate
return: ServiceFactory

createService($serviceName,CredentialsInterface $credentials,TokenStorageInterface $storage,$scopes = array()   X-Ref
Builds and returns oauth services

It will first try to build an OAuth2 service and if none found it will try to build an OAuth1 service

param: string                $serviceName Name of service to create
param: CredentialsInterface  $credentials
param: TokenStorageInterface $storage
param: array|null            $scopes      If creating an oauth2 service, array of scopes
param: UriInterface|null     $baseApiUri
param: string                $apiVersion version of the api call
return: ServiceInterface

getFullyQualifiedServiceName($serviceName, $type)   X-Ref
Gets the fully qualified name of the service

param: string $serviceName The name of the service of which to get the fully qualified name
param: string $type        The type of the service to get (either OAuth1 or OAuth2)
return: string The fully qualified name of the service

buildV2Service($serviceName,CredentialsInterface $credentials,TokenStorageInterface $storage,array $scopes,UriInterface $baseApiUri = null,$apiVersion = "")   X-Ref
Builds v2 services

param: string                $serviceName The fully qualified service name
param: CredentialsInterface  $credentials
param: TokenStorageInterface $storage
param: array|null            $scopes      Array of scopes for the service
param: UriInterface|null     $baseApiUri
return: ServiceInterface

resolveScopes($serviceName, array $scopes)   X-Ref
Resolves scopes for v2 services

param: string  $serviceName The fully qualified service name
param: array   $scopes      List of scopes for the service
return: array List of resolved scopes

buildV1Service($serviceName,CredentialsInterface $credentials,TokenStorageInterface $storage,$scopes,UriInterface $baseApiUri = null)   X-Ref
Builds v1 services

param: string                $serviceName The fully qualified service name
param: CredentialsInterface  $credentials
param: TokenStorageInterface $storage
param: array                 $scopes
param: UriInterface          $baseApiUri
return: ServiceInterface



Generated: Mon Oct 4 17:42:11 2021 Cross-referenced by PHPXref 0.7.1