oauth.lib.php File Reference

Function for module Oauth. More...

Go to the source code of this file.

Functions
	getAllOauth2Array ()
	Return array of possible OAUTH2 services.
	getSupportedOauth2Array ()
	Return array of tabs to use on pages to setup cron module.
	getOauthSetupDiagnostic ($genericstring, $keyforprovider='')
	Return a human readable diagnostic of the setup of an OAuth2 provider entry, to append to an error message or a log line.
	oauthadmin_prepare_head ()
	Return array of tabs to used on pages to setup cron module.

Detailed Description

Function for module Oauth.

Definition in file oauth.lib.php.

Function Documentation

getAllOauth2Array()

getAllOauth2Array

(

)

Return array of possible OAUTH2 services.

Returns

array<string[]> Array of services

Definition at line 35 of file oauth.lib.php.

getOauthSetupDiagnostic()

getOauthSetupDiagnostic	(		$genericstring,
			$keyforprovider = '' )

Return a human readable diagnostic of the setup of an OAuth2 provider entry, to append to an error message or a log line.

Only tells whether each constant is filled, never their value.

Parameters

string	$genericstring	Provider key in uppercase used to build the constants (example: 'MICROSOFT3')
string	$keyforprovider	Label of the provider entry, empty for the unnamed one

Returns

string Example: "service=Microsoft3-mylabel, entity=1, OAUTH_MICROSOFT3-mylabel_ID=set, OAUTH_MICROSOFT3-mylabel_SCOPE=MISSING"

Definition at line 389 of file oauth.lib.php.

References $conf.

getSupportedOauth2Array()

getSupportedOauth2Array

(

)

Return array of tabs to use on pages to setup cron module.

Returns

array<string,array<string,string>> Array of tabs

Definition at line 287 of file oauth.lib.php.

References isModEnabled().

Referenced by CMailFile\sendfile().

oauthadmin_prepare_head()

oauthadmin_prepare_head

(

)

Return array of tabs to used on pages to setup cron module.

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 421 of file oauth.lib.php.

References $conf, and complete_head_from_modules().