PHP Class JsConnectPlugin, addons

Inheritance: extends Gdn_Plugin

Afficher le fichier Open project: vanilla/addons Class Usage Examples

Méthodes publiques

Méthode	Description
addControl ( string $key, array $item )	Add an element to the controls collection. Used to render settings forms.
allConnectButtons ( array $Options = [] ) : string
authenticationProviderModel_calculateJsConnect_handler ( AuthenticationProviderModel $sender, array $args )	Calculate the final sign in and register urls for jsConnect.
base_beforeSignInButton_handler ( Gdn_Controller $Sender, $Args )
base_beforeSignInLink_handler ( Gdn_Controller $Sender )
base_connectData_handler ( EntryController $Sender, array $Args )
base_getAppSettingsMenuItems_handler ( Gdn_Controller $Sender )
base_render_before ( Gdn_Controller $Sender, $Args )
connectButton ( $Provider, array $Options = [] ) : string
connectUrl ( $Provider, boolean $Secure = false, boolean $Callback = true ) : boolean \| string
entryController_jsConnect_create ( EntryController $Sender, string $Action = '', string $Target = '' )	An intermediate page for jsConnect that checks SSO against and then posts the information to /entry/connect.
entryController_signIn_handler ( Gdn_Controller $Sender, $Args )
getAllProviders ( ) : array \| mixed	Convenience method for functional clarity.
getProvider ( null $client_id = null ) : array \| mixed
getRegisterUrl ( array \| integer $provider, string \| null $target = null ) : string	Gets the full sign in url with the jsConnect redirect added.
getSignInUrl ( arrat \| integer $provider, string \| null $target = null ) : string	Gets the full sign in url with the jsConnect redirect added.
profileController_jsConnect_create ( Gdn_Controller $Sender, array $Args = [] )
rootController_sso_handler ( RootController $Sender, $Args )
settingsController_jsConnect_create ( SettingsController $Sender, array $Args = [] )
settings_delete ( $Sender, $Args )

Méthodes protégées

Méthode	Description
connectQueryString ( $provider, null $target = null ) : array
settings_addEdit ( SettingsController $sender, array $Args )
settings_index ( $Sender, $Args )

Method Details

addControl() public méthode

Add an element to the controls collection. Used to render settings forms.

public addControl ( string $key, array $item )
$key	string
$item	array

allConnectButtons() public static méthode

public static allConnectButtons ( array $Options = [] ) : string
$Options	array
Résultat	string

authenticationProviderModel_calculateJsConnect_handler() public méthode

Calculate the final sign in and register urls for jsConnect.

public authenticationProviderModel_calculateJsConnect_handler ( AuthenticationProviderModel $sender, array $args )
$sender	AuthenticationProviderModel	Not used.
$args	array	Contains the provider and

base_beforeSignInButton_handler() public méthode

public base_beforeSignInButton_handler ( Gdn_Controller $Sender, $Args )
$Sender	Gdn_Controller
$Args

base_beforeSignInLink_handler() public méthode

public base_beforeSignInLink_handler ( Gdn_Controller $Sender )
$Sender	Gdn_Controller

base_connectData_handler() public méthode

public base_connectData_handler ( EntryController $Sender, array $Args )
$Sender	EntryController
$Args	array

base_getAppSettingsMenuItems_handler() public méthode

public base_getAppSettingsMenuItems_handler ( Gdn_Controller $Sender )
$Sender	Gdn_Controller

base_render_before() public méthode

public base_render_before ( Gdn_Controller $Sender, $Args )
$Sender	Gdn_Controller
$Args

connectButton() public static méthode

public static connectButton ( $Provider, array $Options = [] ) : string
$Provider
$Options	array
Résultat	string

connectQueryString() protected static méthode

protected static connectQueryString ( $provider, null $target = null ) : array
$provider
$target	null
Résultat	array

connectUrl() public static méthode

public static connectUrl ( $Provider, boolean $Secure = false, boolean $Callback = true ) : boolean \| string
$Provider
$Secure	boolean
$Callback	boolean
Résultat	boolean \| string

entryController_jsConnect_create() public méthode

An intermediate page for jsConnect that checks SSO against and then posts the information to /entry/connect.

public entryController_jsConnect_create ( EntryController $Sender, string $Action = '', string $Target = '' )
$Sender	EntryController
$Action	string	A specific action. It can be one of the following: - blank: The default action. - guest: There is no user signed in. -
$Target	string	The url to redirect to after a successful connect.

entryController_signIn_handler() public méthode

public entryController_signIn_handler ( Gdn_Controller $Sender, $Args )
$Sender	Gdn_Controller

getAllProviders() public static méthode

Convenience method for functional clarity.

public static getAllProviders ( ) : array \| mixed
Résultat	array \| mixed

getProvider() public static méthode

public static getProvider ( null $client_id = null ) : array \| mixed
$client_id	null
Résultat	array \| mixed

getRegisterUrl() public static méthode

Gets the full sign in url with the jsConnect redirect added.

public static getRegisterUrl ( array \| integer $provider, string \| null $target = null ) : string
$provider	array \| integer	The authentication provider or its ID.
$target	string \| null	The url to redirect to after signing in or null to guess the target.
Résultat	string	Returns the sign in url.

getSignInUrl() public static méthode

Gets the full sign in url with the jsConnect redirect added.

public static getSignInUrl ( arrat \| integer $provider, string \| null $target = null ) : string
$provider	arrat \| integer	The authentication provider or its ID.
$target	string \| null	The url to redirect to after signing in or null to guess the target.
Résultat	string	Returns the sign in url.

profileController_jsConnect_create() public méthode

public profileController_jsConnect_create ( Gdn_Controller $Sender, array $Args = [] )
$Sender	Gdn_Controller
$Args	array

rootController_sso_handler() public méthode

public rootController_sso_handler ( RootController $Sender, $Args )
$Sender	RootController
$Args

settingsController_jsConnect_create() public méthode

public settingsController_jsConnect_create ( SettingsController $Sender, array $Args = [] )
$Sender	SettingsController
$Args	array

settings_addEdit() protected méthode

protected settings_addEdit ( SettingsController $sender, array $Args )
$sender	SettingsController
$Args	array

settings_delete() public méthode

public settings_delete ( $Sender, $Args )
$Sender
$Args

settings_index() protected méthode

protected settings_index ( $Sender, $Args )
$Sender
$Args