oauth2_client Class Reference

OAuth 2.0 Client for using web access tokens. More...

Inheritance diagram for oauth2_client:

Public Member Functions
	__construct ($clientid, $clientsecret, moodle_url $returnurl, $scope)
	Constructor.
	build_post_data ($params)
	Given an array of name value pairs - build a valid HTTP POST application/x-www-form-urlencoded string.
	cleanopt ()
	Reset http method.
	delete ($url, $param=array(), $options=array())
	HTTP DELETE method.
	download ($requests, $options=array())
	Download multiple files in parallel.
	download_one ($url, $params, $options=array())
	Downloads one file and writes it to the specified file handler.
	get ($url, $params=array(), $options=array())
	HTTP GET method.
	get_accesstoken ()
	Get access token object.
	get_additional_login_parameters ()
	An additional array of url params to pass with a login request.
	get_clientid ()
	Get the client ID.
	get_clientsecret ()
	Get the client secret.
	get_errno ()
	Get curl error code.
	get_info ()
	Get curl information.
	get_login_url ()
	Returns the login link for this oauth request.
	get_raw_response ()
	Get raw HTTP Response Headers.
	get_refresh_token ()
	Get a refresh token!!!
	get_security ()
	Returns the current curl security helper.
	getResponse ()
	Get HTTP Response Headers.
	head ($url, $options=array())
	HTTP HEAD method.
	is_logged_in ()
	Is the user logged in? Note that if this is called after the first part of the authorisation flow the token is upgraded to an accesstoken.
	log_out ()
	Logs out of a oauth request, clearing any stored tokens.
	options ($url, $options=array())
	HTTP OPTIONS method.
	patch ($url, $params='', $options=array())
	HTTP PATCH method.
	post ($url, $params='', $options=array())
	HTTP POST method.
	put ($url, $params=array(), $options=array())
	HTTP PUT method.
	resetcookie ()
	Reset Cookie.
	resetHeader ()
	Resets the HTTP Request headers (to prepare for the new request)
	resetopt ()
	Resets the CURL options that have already been set.
	set_security ($securityobject)
	Sets the curl security helper.
	setHeader ($header)
	Set HTTP Request Header.
	setopt ($options=array())
	Set curl options.
	trace ($url, $options=array())
	HTTP TRACE method.
	upgrade_token ($code)
	Upgrade a authorization token from oauth 2.0 to an access token.

Static Public Member Functions
static	callback_url ()
	Callback url where the request is returned to.
static	get_cacert ()
	Get the location of ca certificates.
static	mock_response ($response)
	For use only in unit tests - we can pre-set the next curl response.
static	strip_double_headers ($input)
	When using a proxy, an additional HTTP response code may appear at the start of the header.

Public Attributes
array	$_tmp_file_post_params = []
	temporary params value if the value is not belongs to class stored_file.
curl_cache false	$cache = false
	Caches http request contents.
bool	$emulateredirects = null
	Perform redirects at PHP level instead of relying on native cURL functionality.
int	$errno
	error code
string	$error
	error
array	$header = array()
	http header
array	$info
	cURL information
bool	$proxy = null
	Uses proxy, null means automatic based on URL.
array	$rawresponse = array()
	Raw response headers, needed for BC in download_file_content().
array	$response = array()
	http's response
string	$version = '0.4 dev'
	library version

Protected Member Functions
	auth_url ()
	Returns the auth url for OAuth 2.0 request.
	check_securityhelper_blocklist (string $url)
	check_securityhelper_blocklist.
	get_stored_token ()
	Retrieve a token stored.
	get_tokenname ()
	Returns the tokenname for the access_token to be stored through multiple requests.
	multi ($requests, $options=array())
	Multiple HTTP Requests This function could run multi-requests in parallel.
	request ($url, $options=array())
	Single HTTP Request.
	request ($url, $options=array(), $acceptheader='application/json')
	Make a HTTP request, adding the access token we have.
	reset_request_state_vars ()
	Helper function to reset the request state vars.
	store_token ($token)
	Store a token between requests.
	token_url ()
	Returns the token url for OAuth 2.0 request.
	use_http_get ()
	Should HTTP GET be used instead of POST? Some APIs do not support POST and want oauth to use GET instead (with the auth_token passed as a GET param).

Protected Attributes
stdClass	$accesstoken = null
	$accesstoken access token object
bool	$basicauth = false
	basicauth
string	$refreshtoken = ''
	$refreshtoken refresh token string
string	$scope = ''
	$scope of the authentication request

Detailed Description

OAuth 2.0 Client for using web access tokens.

http://tools.ietf.org/html/draft-ietf-oauth-v2-22

Copyright

Dan Poltawski talkt.nosp@m.odan.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

oauth2_client::__construct	(		$clientid,
			$clientsecret,
		moodle_url	$returnurl,
			$scope )

Constructor.

Parameters

string	$clientid
string	$clientsecret
moodle_url	$returnurl
string	$scope

Member Function Documentation

auth_url()

oauth2_client::auth_url ( )

abstractprotected

Returns the auth url for OAuth 2.0 request.

Return values

string

the auth url

Reimplemented in core\oauth2\client, google_oauth, and repository_dropbox\dropbox.

build_post_data()

oauth2_client::build_post_data

(

$params

)

Given an array of name value pairs - build a valid HTTP POST application/x-www-form-urlencoded string.

Parameters

array

$params

Name / value pairs.

Return values

string

POST data.

callback_url()

static oauth2_client::callback_url ( )

static

Callback url where the request is returned to.

Return values

moodle_url

url of callback

Reimplemented in core_badges\oauth2\client.

check_securityhelper_blocklist()

curl::check_securityhelper_blocklist ( string $url )

protectedinherited

check_securityhelper_blocklist.

Checks whether the given URL is blocked by checking both plugin's security helpers and core curl security helper or any curl security helper that passed to curl class constructor. If ignoresecurity is set to true, skip checking and consider the url is not blocked. This augments all installed plugin's security helpers if there is any.

Parameters

string

$url

the url to check.

Return values

string

- an error message if URL is blocked or null if URL is not blocked.

delete()

curl::delete ( $url, $param = array(), $options = array() )

inherited

HTTP DELETE method.

Parameters

string	$url
array	$param
array	$options

Return values

bool

download()

curl::download ( $requests, $options = array() )

inherited

Download multiple files in parallel.

Calls multi() with specific download headers

$c = new curl(); $file1 = fopen('a', 'wb'); $file2 = fopen('b', 'wb'); $c->download(array( array('url'=>'http://localhost/', 'file'=>$file1), array('url'=>'http://localhost/20/', 'file'=>$file2) )); fclose($file1); fclose($file2);

or

$c = new curl(); $c->download(array( array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'), array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp') ));

Parameters

array	$requests	An array of files to request { url => url to download the file [required] file => file handler, or filepath => file path } If 'file' and 'filepath' parameters are both specified in one request, the open file handle in the 'file' parameter will take precedence and 'filepath' will be ignored.
array	$options	An array of options to set

Return values

array

An array of results

download_one()

curl::download_one ( $url, $params, $options = array() )

inherited

Downloads one file and writes it to the specified file handler.

$c = new curl(); $file = fopen('savepath', 'w'); $result = $c->download_one('http://localhost/', null, array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3)); fclose($file); $download_info = $c->get_info(); if ($result === true) { // file downloaded successfully } else { $error_text = $result; $error_code = $c->get_errno(); }

$c = new curl(); $result = $c->download_one('http://localhost/', null, array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3)); // ... see above, no need to close handle and remove file if unsuccessful

Parameters

string	$url
array | null	$params	key-value pairs to be added to $url as query string
array	$options	request options. Must include either 'file' or 'filepath'

Return values

bool|string

true on success or error string on failure

get()

curl::get ( $url, $params = array(), $options = array() )

inherited

HTTP GET method.

Parameters

string	$url
array	$params
array	$options

Return values

bool

get_accesstoken()

oauth2_client::get_accesstoken

(

)

Get access token object.

This is just a getter to read the private property.

Return values

stdClass

get_additional_login_parameters()

oauth2_client::get_additional_login_parameters

(

)

An additional array of url params to pass with a login request.

Return values

array

of name value pairs.

Reimplemented in core\oauth2\client.

get_cacert()

static curl::get_cacert ( )

staticinherited

Get the location of ca certificates.

Return values

string

absolute file path or empty if default used

get_clientid()

oauth2_client::get_clientid

(

)

Get the client ID.

This is just a getter to read the private property.

Return values

string

get_clientsecret()

oauth2_client::get_clientsecret

(

)

Get the client secret.

This is just a getter to read the private property.

Return values

string

get_errno()

curl::get_errno ( )

inherited

Get curl error code.

Return values

int

get_info()

curl::get_info ( )

inherited

Get curl information.

Return values

array

get_login_url()

oauth2_client::get_login_url

(

)

Returns the login link for this oauth request.

Return values

moodle_url

login url

Reimplemented in core_badges\oauth2\client.

get_raw_response()

curl::get_raw_response ( )

inherited

Get raw HTTP Response Headers.

Return values

array

of strings

get_refresh_token()

oauth2_client::get_refresh_token

(

)

Get a refresh token!!!

Return values

string

get_security()

curl::get_security ( )

inherited

Returns the current curl security helper.

Return values

core\files\curl_security_helper

instance.

get_stored_token()

oauth2_client::get_stored_token ( )

protected

Retrieve a token stored.

Return values

stdClass|null

token object

Reimplemented in core\oauth2\client, and core_badges\oauth2\client.

get_tokenname()

oauth2_client::get_tokenname ( )

protected

Returns the tokenname for the access_token to be stored through multiple requests.

The default implentation is to use the classname combiend with the scope.

Return values

string

tokenname for prefernce storage

Reimplemented in core\oauth2\client.

getResponse()

curl::getResponse ( )

inherited

Get HTTP Response Headers.

Return values

array

of arrays

head()

curl::head ( $url, $options = array() )

inherited

HTTP HEAD method.

See also

request()

Parameters

string	$url
array	$options

Return values

bool

is_logged_in()

oauth2_client::is_logged_in

(

)

Is the user logged in? Note that if this is called after the first part of the authorisation flow the token is upgraded to an accesstoken.

Return values

boolean

true if logged in

Reimplemented in core\oauth2\client, and core_badges\oauth2\client.

log_out()

oauth2_client::log_out

(

)

Logs out of a oauth request, clearing any stored tokens.

Reimplemented in core\oauth2\client.

mock_response()

static curl::mock_response ( $response )

staticinherited

For use only in unit tests - we can pre-set the next curl response.

This is useful for unit testing APIs that call external systems.

Parameters

string

$response

multi()

oauth2_client::multi ( $requests, $options = array() )

protected

Multiple HTTP Requests This function could run multi-requests in parallel.

Parameters

array	$requests	An array of files to request
array	$options	An array of options to set

Return values

array

An array of results

Reimplemented from curl.

options()

curl::options ( $url, $options = array() )

inherited

HTTP OPTIONS method.

Parameters

string	$url
array	$options

Return values

bool

patch()

curl::patch ( $url, $params = '', $options = array() )

inherited

HTTP PATCH method.

Parameters

string	$url
array | string	$params
array	$options

Return values

bool

post()

curl::post ( $url, $params = '', $options = array() )

inherited

HTTP POST method.

Parameters

string	$url
array | string	$params
array	$options

Return values

bool

put()

curl::put ( $url, $params = array(), $options = array() )

inherited

HTTP PUT method.

Parameters

string	$url
array	$params
array	$options

Return values

bool

request() [1/2]

curl::request ( $url, $options = array() )

protectedinherited

Single HTTP Request.

Parameters

string	$url	The URL to request
array	$options

Return values

bool

request() [2/2]

oauth2_client::request ( $url, $options = array(), $acceptheader = 'application/json' )

protected

Make a HTTP request, adding the access token we have.

Parameters

string	$url	The URL to request
array	$options
mixed	$acceptheader	mimetype (as string) or false to skip sending an accept header.

Return values

bool

Reimplemented in google_oauth.

reset_request_state_vars()

curl::reset_request_state_vars ( )

protectedinherited

Helper function to reset the request state vars.

Return values

void.

set_security()

curl::set_security ( $securityobject )

inherited

Sets the curl security helper.

Parameters

core\files\curl_security_helper

$securityobject

instance/subclass of the base curl_security_helper class.

Return values

bool	true if the security helper could be set, false otherwise.

setHeader()

curl::setHeader ( $header )

inherited

Set HTTP Request Header.

Parameters

array

$header

setopt()

curl::setopt ( $options = array() )

inherited

Set curl options.

Do not use the curl constants to define the options, pass a string corresponding to that constant. Ie. to set CURLOPT_MAXREDIRS, pass array('CURLOPT_MAXREDIRS' => 10) or array('maxredirs' => 10) to this method.

Parameters

array

$options

If array is null, this function will reset the options to default value.

Return values

void

Exceptions

coding_exception

If an option uses constant value instead of option name.

store_token()

oauth2_client::store_token ( $token )

protected

Store a token between requests.

Currently uses session named by get_tokenname

Parameters

stdClass | null

$token

token object to store or null to clear

Reimplemented in core\oauth2\client, and core_badges\oauth2\client.

strip_double_headers()

static curl::strip_double_headers ( $input )

staticinherited

When using a proxy, an additional HTTP response code may appear at the start of the header.

For example, when using https over a proxy there may be 'HTTP/1.0 200 Connection Established'. Other codes are also possible and some may come with their own headers.

If using the return value containing all headers, this function can be called to remove unwanted doubles.

Note that it is not possible to distinguish this situation from valid data unless you know the actual response part (below the headers) will not be included in this string, or else will not 'look like' HTTP headers. As a result it is not safe to call this function for general data.

Parameters

string

$input

Input HTTP response

Return values

string

HTTP response with additional headers stripped if any

token_url()

oauth2_client::token_url ( )

abstractprotected

Returns the token url for OAuth 2.0 request.

Return values

string

the auth url

Reimplemented in core\oauth2\client, google_oauth, and repository_dropbox\dropbox.

trace()

curl::trace ( $url, $options = array() )

inherited

HTTP TRACE method.

Parameters

string	$url
array	$options

Return values

bool

upgrade_token()

oauth2_client::upgrade_token

(

$code

)

Upgrade a authorization token from oauth 2.0 to an access token.

Parameters

string

$code

the code returned from the oauth authenticaiton

Return values

boolean

true if token is upgraded succesfully

Reimplemented in core\oauth2\client.

use_http_get()

oauth2_client::use_http_get ( )

protected

Should HTTP GET be used instead of POST? Some APIs do not support POST and want oauth to use GET instead (with the auth_token passed as a GET param).

Return values

bool	true if GET should be used

Member Data Documentation

$emulateredirects

bool curl::$emulateredirects = null

inherited

Perform redirects at PHP level instead of relying on native cURL functionality.

Always true now.

---

The documentation for this class was generated from the following file:

• lib/oauthlib.php