[ Index ]

PHP Cross Reference of phpBB-3.3.14-deutsch

title

Body

[close]

/phpbb/auth/provider/oauth/service/ -> service_interface.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 85 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

service_interface:: (7 methods):
  get_auth_scope()
  get_service_credentials()
  perform_auth_login()
  perform_token_auth()
  get_external_service_class()
  get_external_service_provider()
  set_external_service_provider()


Interface: service_interface  - X-Ref

OAuth service interface

get_auth_scope()   X-Ref
Returns an array of the scopes necessary for auth

return: array    An array of the required scopes

get_service_credentials()   X-Ref
Returns an array containing the service credentials belonging to requested
service.

return: array    An array containing the 'key' and the 'secret' of the

perform_auth_login()   X-Ref
Returns the results of the authentication in json format

return: string    The unique identifier returned by the service provider

perform_token_auth()   X-Ref
Returns the results of the authentication in json format
Use this function when the user already has an access token

return: string    The unique identifier returned by the service provider

get_external_service_class()   X-Ref
Returns the class of external library service provider that has to be used.

return: string    If the string is a class, it will register the provided string as a class,

get_external_service_provider()   X-Ref
Returns the external library service provider once it has been set


set_external_service_provider(\OAuth\Common\Service\ServiceInterface $service_provider)   X-Ref
Sets the external library service provider

param: \OAuth\Common\Service\ServiceInterface    $service_provider



Generated: Mon Nov 25 19:05:08 2024 Cross-referenced by PHPXref 0.7.1