include/externalAPI/Base/OAuthPluginBase.php

Show:

inherited

Classes
- \OAuthPluginBase

Table of Contents

\OAuthPluginBase
jump to top

Package: SugarCRM

External API based on OAuth

Parent(s): \ExternalAPIBase < \ExternalAPIPlugin
Api

Constants

 
                APP_STRING_ERROR_PREFIX
                = 'ERR_EXTERNAL_API_'

inheritedInherited from: \ExternalAPIBase::APP_STRING_ERROR_PREFIX

Inherited_from: \ExternalAPIBase::APP_STRING_ERROR_PREFIX

Properties


                 $_appStringErrorPrefix= 'self::APP_STRING_ERROR_PREFIX'

inheritedInherited from: \ExternalAPIBase::$$_appStringErrorPrefix

Default valueself::APP_STRING_ERROR_PREFIXDetails

Type: n/a
Inherited_from: \ExternalAPIBase::$$_appStringErrorPrefix


                 $account_name= ''

inheritedInherited from: \ExternalAPIBase::$$account_name

Details

Type: n/a
Inherited_from: \ExternalAPIBase::$$account_name


                 $account_password= ''

inheritedInherited from: \ExternalAPIBase::$$account_password

Details

Type: n/a
Inherited_from: \ExternalAPIBase::$$account_password

\EAPM
                 $authData= ''

inherited

Authorization data

Inherited from: \ExternalAPIBase::$$authData

Details

Type: \EAPM
Inherited_from: \ExternalAPIBase::$$authData


                 $authMethod= ''oauth''

Default value'oauth'Details

Type: n/a


                 $oauthParams= 'array()'

Default valuearray()Details

Type: n/a


                 $oauth_keys_initialized= 'false'

Default valuefalseDetails

Type: n/a


                 $requireAuth= 'true'

inheritedInherited from: \ExternalAPIBase::$$requireAuth

Default valuetrueDetails

Type: n/a
Inherited_from: \ExternalAPIBase::$$requireAuth


                 $useAuth= 'true'

inheritedInherited from: \ExternalAPIBase::$$useAuth

Default valuetrueDetails

Type: n/a
Inherited_from: \ExternalAPIBase::$$useAuth

Methods

__construct(
          
          )
        
        :
          void

checkLogin(
          \EAPM $eapmBean
              =
              null
          )
        
        :
          void

Check login

Parameters

Name	Type	Description
$eapmBean	\EAPM

Details

See: \ExternalAPIBase::checkLogin()

checkOauthLogin(
          
          )
        
        :
          void

formatCallbackURL(
          \$callback_url $callback_url
          )
        
        :
          String

inherited

formatCallbackURL

Inherited from: \ExternalAPIBase::formatCallbackURL()

This function takes a callback_url and checks the $_REQUEST variable to see if additional parameters should be appended to the callback_url value. The $_REQUEST variables that are being checked deal with handling the behavior of closing/hiding windows/tabs that are displayed when prompting for OAUTH validation

Parameters

Name	Type	Description
$callback_url	\$callback_url	String value of callback URL

Returns

Type	Description
String	value of URL with applicable formatting

getConnector(
          
          )
        
        :
          \source | null

inherited

Get connector for this API

Inherited from: \ExternalAPIBase::getConnector()

Returns

Type	Description
\source \| null

getConnectorParam(
          string $name
          )
        
        :
          mixed

inherited

Get parameter from source

Inherited from: \ExternalAPIBase::getConnectorParam()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getErrorStringFromCode(
          \unknown_type $error_numb
          )
        
        :
          void

inherited

Allow API clients to provide translated language strings for a given error code

Inherited from: \ExternalAPIBase::getErrorStringFromCode()

Parameters

Name	Type	Description
$error_numb	\unknown_type

getOauth(
          
          )
        
        :
          \SugarOauth

Get OAuth client

Returns

Type	Description
\SugarOauth

getOauthAccessURL(
          
          )
        
        :
          void

getOauthAuthURL(
          
          )
        
        :
          void

getOauthParams(
          
          )
        
        :
          void

getOauthRequestURL(
          
          )
        
        :
          void

getValue(
           $value
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::getValue()

Parameters

Name	Type	Description
$value

isMimeDetectionAvailable(
          
          )
        
        :
          bool

inherited

Determine if mime detection extensions are available.

Inherited from: \ExternalAPIBase::isMimeDetectionAvailable()

Returns

Type	Description
bool

loadEAPM(
          \EAPM $eapmBean
          )
        
        :
          void

Load data from EAPM bean

Parameters

Name	Type	Description
$eapmBean	\EAPM

Details

See: \ExternalAPIBase::loadEAPM()

logOff(
          
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::logOff()

oauthLogin(
          
          )
        
        :
          void

postData(
           $url,  $postfields,  $headers
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::postData()

Parameters

Name	Type	Description
$url
$postfields
$headers

quickCheckLogin(
          
          )
        
        :
          void

setupOauthKeys(
          
          )
        
        :
          void

Setup oauth parameters from connector

supports(
           $method
              =
              ''
          )
        
        :
          void

inherited

Does API support this method?

Inherited from: \ExternalAPIBase::supports()

Parameters

Name	Type	Description
$method

Details

See: \ExternalAPIPlugin::supports()

include/externalAPI/Base/OAuthPluginBase.php

\OAuthPluginBasejump to top

Constants

Properties

Methods

\OAuthPluginBase
jump to top