[ Index ]

PHP Cross Reference of phpBB-3.3.0-deutsch

title

Body

[close]

/phpbb/auth/provider/oauth/ -> oauth.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: 859 lines (24 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

oauth:: (20 methods):
  __construct()
  init()
  login()
  get_login_data()
  acp()
  get_acp_template()
  login_link_has_necessary_data()
  link_account()
  logout()
  get_auth_link_data()
  unlink_account()
  link_account_login_link()
  link_account_auth_link()
  link_account_perform_link()
  get_service()
  get_service_name()
  get_provider()
  get_provider_title()
  is_set_code()
  set_redirect()


Class: oauth  - X-Ref

OAuth authentication provider for phpBB3

__construct(config $config,driver_interface $db,db $db_auth,dispatcher $dispatcher,language $language,request_interface $request,service_collection $service_providers,user $user,$oauth_token_table,$oauth_state_table,$oauth_account_table,$users_table,$root_path,$php_ext)   X-Ref
Constructor.

param: config                $config                    Config object
param: driver_interface    $db                        Database object
param: db            $db_auth                DB auth provider
param: dispatcher            $dispatcher                Event dispatcher object
param: language            $language                Language object
param: request_interface    $request                Request object
param: service_collection        $service_providers        OAuth providers service collection
param: user                        $user                    User object
param: string                            $oauth_token_table        OAuth table: token storage
param: string                            $oauth_state_table        OAuth table: state
param: string                            $oauth_account_table    OAuth table: account association
param: string                            $users_table            User table
param: string                            $root_path                phpBB root path
param: string                            $php_ext                php File extension

init()   X-Ref
{@inheritdoc}


login($username, $password)   X-Ref
{@inheritdoc}


get_login_data()   X-Ref
{@inheritdoc}


acp()   X-Ref
{@inheritdoc}


get_acp_template($new_config)   X-Ref
{@inheritdoc}


login_link_has_necessary_data($login_link_data)   X-Ref
{@inheritdoc}


link_account(array $link_data)   X-Ref
{@inheritdoc}


logout($data, $new_session)   X-Ref
{@inheritdoc}


get_auth_link_data($user_id = 0)   X-Ref
{@inheritdoc}


unlink_account(array $link_data)   X-Ref
{@inheritdoc}


link_account_login_link(array $link_data, $service_name)   X-Ref
Performs the account linking for login_link.

return: string|false                Returns a language key (string) if an error is encountered,
param: array        $link_data        The same variable given to
param: string    $service_name    The name of the service being used in linking.

link_account_auth_link(array $link_data, $service_name)   X-Ref
Performs the account linking for auth_link.

return: string|false                Returns a language constant (string) if an error is encountered,
param: array        $link_data        The same variable given to
param: string    $service_name    The name of the service being used in linking.

link_account_perform_link(array $data)   X-Ref
Performs the query that inserts an account link

param: array    $data    This array is passed to db->sql_build_array

get_service($provider, token_storage $storage, $query)   X-Ref
Returns a new service object.

return: ServiceInterface
param: string            $provider        The name of the provider
param: token_storage        $storage        Token storage object
param: string            $query            The query string used for the redirect uri

get_service_name($provider)   X-Ref
Returns the service name for an OAuth provider name.

return: string                    The service name
param: string    $provider        The OAuth provider name

get_provider($service_name)   X-Ref
Returns the OAuth provider name from a service name.

return: string                    The OAuth provider name
param: string    $service_name    The service name

get_provider_title($provider)   X-Ref
Returns the localized title for the OAuth provider.

return: string                    The OAuth provider title
param: string    $provider        The OAuth provider name

is_set_code($service)   X-Ref
Returns whether or not the authorization code is set.

return: bool                                        Whether or not the authorization code is set in the URL
param: OAuth1Service|OAuth2Service    $service    The external OAuth service

set_redirect($service)   X-Ref
Sets a redirect to the authorization uri.

return: array|false                                Array if an error occurred,
param: OAuth1Service|OAuth2Service $service        The external OAuth service



Generated: Tue Apr 7 19:44:41 2020 Cross-referenced by PHPXref 0.7.1