• 홈
• Gdn_OAuth2

PHP 클래스 Gdn_OAuth2, vanilla

Base class to be extended by any plugin that wants to use Oauth2 protocol for SSO. WARNING This is a base class for the purposes of being extended by other plugins. It is not to be instantiated on its own. For most OAuth2 SSO needs the generic plugins/OAuth2/class.Oauth2.plugin.php should be adequate. If not, create a plugin that extends this class, Gdn_OAuth2, and overwrite any of its methods of constants. 파일 보기 프로젝트 열기: vanilla/vanilla

보호된 프로퍼티들

프로퍼티	타입	설명
$accessToken		token provider by authenticator
$authorizeUriParams		optional additional get parameters to be passed in the authorize_uri
$defaultContentType		content type for API calls
$profileRequestParams		optional additional get params to be passed in the request for profile
$provider		stored information to connect with provider (secret, etc.)
$providerKey		key for GDN_UserAuthenticationProvider table
$requestAccessTokenParams		optional additional post parameters to be passed in the accessToken request
$scope		passing scope to authenticator
$settingsView

공개 메소드들

메소드	설명
__construct ( string $providerKey, boolean | string $accessToken = false )	Set up OAuth2 access properties.
accessToken ( boolean | string $newValue = false ) : boolean | string | null	Renew or return access token.
assetModel_styleCss_handler ( $sender, $args )	Insert css file for generic styling of signin button/icon.
authorizeUri ( array $state = [] ) : string	Create the URI that can return an authorization.
base_beforeSignInButton_handler ( $sender, $args )	Inject a sign-in icon into the ME menu.
base_connectData_handler ( $sender, $args )	Inject into the process of the base connection.
entryController_overrideSignIn_handler ( $sender, $args ) : mixed | boolean	Redirect to provider's signin page if this is the default behaviour.
entryController_signIn_handler ( $sender, $args ) : mixed | boolean	Inject sign-in button into the sign in page.
entryEndpoint ( $sender, $code, $state )	Create a controller to handle entry request.
gdn_pluginManager_afterStart_handler ( $sender )	Register a call back function so that multiple plugins can use it as an entry point on SSO.
getAccessTokenRequestOptions ( ) : array	Allow child classes to pass different options to the Token request API call.
getProfile ( ) : array	Get profile data from authentication provider through API.
getProfileRequestOptions ( ) : array	Allow child classes to pass different options to the Profile request API call.
getProviderKey ( ) : string	Get provider key.
isConfigured ( ) : boolean	Check if there is enough data to connect to an authentication provider.
isConnected ( ) : boolean	Check if an access token has been returned from the provider server.
isDefault ( ) : boolean	Check authentication provider table to see if this is the default method for logging in.
log ( $message, $data )
provider ( ) : array	Return all the information saved in provider table.
requestAccessToken ( string $code ) : mixed	Request access token from provider.
requireVal ( string $key, array $arr, string $context = null ) : mixed	Extract values from arrays.
setAccessToken ( string $accessToken )	Set access token received from provider.
setAuthorizeUriParams ( $params )	Set additional params to be added to the get string in the AuthorizeUri string.
setGetProfileParams ( $params )	Set additional params to be added to the get string in the getProfile request.
setProviderKey ( string $providerKey )	Set provider key used to access settings stored in GDN_UserAuthenticationProvider.
setRequestAccessTokenParams ( $params )	Set additional params to be added to the post array in the accessToken request.
setScope ( $scope )	Set scope to be passed to provider.
settingsEndpoint ( $sender, $args )	Create a controller to deal with plugin settings in dashboard.
setup ( )	Setup
signInButton ( string $type = 'button' ) : string	Create signup button specific to this plugin.
structure ( )	Create the structure in the database.
translateProfileResults ( array $rawProfile = [] ) : array	Allow the admin to input the keys that their service uses to send data.

보호된 메소드들

메소드	설명
api ( $uri, string $method = 'GET', array $params = [], array $options = [] ) : mixed | type.	Generic API uses ProxyRequest class to fetch data from remote endpoints.
getSettingsFormFields ( ) : array	Allow child class to over-ride or add form fields to settings.

메소드 상세

프로퍼티 상세