| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 663 lines (22 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
oauth_helper:: (32 methods):
__construct()
get_signable_parameters()
sign()
prepare_oauth_parameters()
setup_oauth_http_header()
setup_oauth_http_options()
request_token()
set_access_token()
get_access_token()
request()
get()
post()
parse_result()
set_nonce()
set_timestamp()
get_timestamp()
get_nonce()
__construct()
is_logged_in()
callback_url()
get_login_url()
upgrade_token()
log_out()
request()
multi()
get_tokenname()
store_token()
get_stored_token()
get_accesstoken()
get_clientid()
get_clientsecret()
use_http_get()
Class: oauth_helper - X-Ref
OAuth helper class| __construct($args) X-Ref |
| Contructor for oauth_helper. Subclass can override construct to build its own $this->http param: array $args requires at least three keys, oauth_consumer_key |
| get_signable_parameters($params) X-Ref |
| Build parameters list: oauth_consumer_key="0685bd9184jfhq22", oauth_nonce="4572616e48616d6d65724c61686176", oauth_token="ad180jjd733klru7", oauth_signature_method="HMAC-SHA1", oauth_signature="wOJIO9A2W5mFwDgiDvZbTSMK%2FPY%3D", oauth_timestamp="137131200", oauth_version="1.0" oauth_verifier="1.0" param: array $param return: string |
| sign($http_method, $url, $params, $secret) X-Ref |
| Create signature for oauth request param: string $url param: string $secret param: array $params return: string |
| prepare_oauth_parameters($url, $params, $http_method = 'POST') X-Ref |
| Initilize oauth request parameters, including: oauth_consumer_key="0685bd9184jfhq22", oauth_token="ad180jjd733klru7", oauth_signature_method="HMAC-SHA1", oauth_signature="wOJIO9A2W5mFwDgiDvZbTSMK%2FPY%3D", oauth_timestamp="137131200", oauth_nonce="4572616e48616d6d65724c61686176", oauth_version="1.0" To access protected resources, oauth_token should be defined param: string $url param: string $token param: string $http_method return: array |
| setup_oauth_http_header($params) X-Ref |
| No description |
| setup_oauth_http_options($options) X-Ref |
| Sets the options for the next curl request param: array $options |
| request_token() X-Ref |
| Request token for authentication This is the first step to use OAuth, it will return oauth_token and oauth_token_secret return: array |
| set_access_token($token, $secret) X-Ref |
| Set oauth access token for oauth request param: string $token param: string $secret |
| get_access_token($token, $secret, $verifier='') X-Ref |
| Request oauth access token from server param: string $method param: string $url param: string $token param: string $secret |
| request($method, $url, $params=array() X-Ref |
| Request oauth protected resources param: string $method param: string $url param: string $token param: string $secret |
| get($url, $params=array() X-Ref |
| shortcut to start http get request |
| post($url, $params=array() X-Ref |
| shortcut to start http post request |
| parse_result($str) X-Ref |
| A method to parse oauth response to get oauth_token and oauth_token_secret param: string $str return: array |
| set_nonce($str) X-Ref |
| Set nonce |
| set_timestamp($time) X-Ref |
| Set timestamp |
| get_timestamp() X-Ref |
| Generate timestamp |
| get_nonce() X-Ref |
| Generate nonce for oauth request |
| __construct($clientid, $clientsecret, moodle_url $returnurl, $scope) X-Ref |
| Constructor. param: string $clientid param: string $clientsecret param: moodle_url $returnurl param: string $scope |
| is_logged_in() X-Ref |
| 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: boolean true if logged in |
| callback_url() X-Ref |
| Callback url where the request is returned to. return: moodle_url url of callback |
| get_login_url() X-Ref |
| Returns the login link for this oauth request return: moodle_url login url |
| upgrade_token($code) X-Ref |
| Upgrade a authorization token from oauth 2.0 to an access token param: string $code the code returned from the oauth authenticaiton return: boolean true if token is upgraded succesfully |
| log_out() X-Ref |
| Logs out of a oauth request, clearing any stored tokens |
| request($url, $options = array() X-Ref |
| Make a HTTP request, adding the access token we have param: string $url The URL to request param: array $options return: bool |
| multi($requests, $options = array() X-Ref |
| Multiple HTTP Requests This function could run multi-requests in parallel. param: array $requests An array of files to request param: array $options An array of options to set return: array An array of results |
| get_tokenname() X-Ref |
| 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: string tokenname for prefernce storage |
| store_token($token) X-Ref |
| Store a token between requests. Currently uses session named by get_tokenname param: stdClass|null $token token object to store or null to clear |
| get_stored_token() X-Ref |
| Retrieve a token stored. return: stdClass|null token object |
| get_accesstoken() X-Ref |
| Get access token. This is just a getter to read the private property. return: string |
| get_clientid() X-Ref |
| Get the client ID. This is just a getter to read the private property. return: string |
| get_clientsecret() X-Ref |
| Get the client secret. This is just a getter to read the private property. return: string |
| use_http_get() X-Ref |
| 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: bool true if GET should be used |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |