BigTreeOAuthAPIBase

Other OAuth APIs inherit from this class. Implements common call patterns.

Functions

Function Description
cacheBust Busts the cache for everything relating to an object.
cachePush Pushes a hash onto the cache hash table.
call Calls the OAuth API directly with the given API endpoint and parameters.
callUncached Calls the OAuth API directly with the given API endpoint and parameters.
disconnect Removes saved API information.
oAuthRedirect Redirects to the OAuth API to authenticate.
oAuthRefreshToken Refreshes an existing token setup.
oAuthSetToken Sets token information (or an error) when provided a response code.
saveSettings Saves the object's settings back to the database.

cacheBust

Busts the cache for everything relating to an object.

cacheBust()

cachePush

Pushes a hash onto the cache hash table.

cachePush()

call

Calls the OAuth API directly with the given API endpoint and parameters.
Caches information unless caching is explicitly disabled on class instantiation or method is not GET.

Return Value: Information directly from the API or the cache. 

call($endpoint, $params, $method, $headers)
Parameter Description
$endpoint The API endpoint to hit.
$params The parameters to send to the API (key/value array).
$method HTTP method to call (defaults to GET).
$headers Additional headers to send.

callUncached

Calls the OAuth API directly with the given API endpoint and parameters.
Does not cache information.

Return Value: Information directly from the API. 

callUncached($endpoint, $params, $method, $headers)
Parameter Description
$endpoint The API endpoint to hit.
$params The parameters to send to the API (key/value array).
$method HTTP method to call (defaults to GET).
$headers Additional headers to send.

disconnect

Removes saved API information.

disconnect()

oAuthRedirect

Redirects to the OAuth API to authenticate.

oAuthRedirect()

oAuthRefreshToken

Refreshes an existing token setup.

oAuthRefreshToken()

oAuthSetToken

Sets token information (or an error) when provided a response code.

Return Value: A stdClass object of information if successful. 

oAuthSetToken()

saveSettings

Saves the object's settings back to the database.

saveSettings()