include/SugarOAuthServer.php

Show: inherited
Table of Contents

\OAuthException

Package:
Parent(s)
\Exception

\SugarOAuthServer

Package: SugarCRM

Sugar OAuth provider implementation

Api
 

Properties

Propertyprotected\OAuthToken  $token= ''

OAuth token

Details
Type
\OAuthToken

Methods

methodpublic__construct(  $req_path = '' ) : void

Create OAuth provider

Checks current request for OAuth valitidy

Parameters
Name Type Description
$req_path
methodpublicaccessToken( ) : string

Generate access token string - must have validated request token

Returns
Type Description
string
methodpublicauthUrl( ) : string

Return authorization URL

Returns
Type Description
string
methodpublicauthorization( ) : mixed

Fetch authorization data from current token

Returns
Type Description
mixed Authorization data or null if none
methodpublicauthorizedToken( ) : \OAuthToken | null

Fetch current token if it is authorized

Returns
Type Description
\OAuthToken | null
methodprotectedcheck( ) : void

Check if everything is OK

Throws
Exception Description
\OAuthException
methodprotecteddecodePostGet( ) : array

Decode POST/GET via from_html()

Returns
Type Description
array decoded data
methodpublicenabled( ) : void
static

Is this functionality enabled?

methodpubliclookupConsumer(  $provider ) : void

Find consumer by key

Parameters
Name Type Description
$provider
methodpublicreportProblem(  $e ) : void

Report OAuth problem as string

Parameters
Name Type Description
$e
methodpublicrequestToken( ) : string

Generate request token string

Returns
Type Description
string
methodpublictimestampNonceChecker( \OAuthProvider $provider ) : void

Check timestamps & nonces

Parameters
Name Type Description
$provider \OAuthProvider
methodpublictokenHandler( \OAuthProvider $provider ) : void

Vefiry incoming token

Parameters
Name Type Description
$provider \OAuthProvider
Documentation was generated by DocBlox 0.18.1.