Class: OpenID_Extension_OAuth

Source Location: /OpenID-0.4.0/OpenID/Extension/OAuth.php

Class Overview

OpenID_Extension
   |
   --OpenID_Extension_OAuth

Provides support for the OAuth extension

Author(s):

Jeff Hodsdon <jeffhodsdon at gmail.com>

Copyright:

2009 Jeff Hodsdon

Variables

Methods

getAccessToken

Inherited Variables

Class: OpenID_Extension

OpenID_Extension::$reserved
OpenID_Extension::$type
OpenID_Extension::$useNamespaceAlias
OpenID_Extension::$values

Inherited Methods

Class: OpenID_Extension

OpenID_Extension::__construct(): Sets the message type, request or response
OpenID_Extension::fromMessageResponse(): Extracts extension contents from an OpenID_Message
OpenID_Extension::get(): Gets a key's value
OpenID_Extension::getNamespace(): Gets the namespace of this extension
OpenID_Extension::set(): Sets a key value pair
OpenID_Extension::toMessage(): Adds the extension contents to an OpenID_Message

Class Details

[line 31]
Provides support for the OAuth extension

Author: Jeff Hodsdon <jeffhodsdon@gmail.com>
Copyright: 2009 Jeff Hodsdon
Link: http://step2.googlecode.com/svn/spec/openid_oauth_extension/latest/openid_oauth_extension.html
Link: http://github.com/shupp/openid
License: FreeBSD
Uses: OpenID_Extension

[ Top ]

Class Variables

$alias = 'oauth'

[line 45]

Alias to use

Access: protected

Type:	string
Overrides:	Array

[ Top ]

$namespace = 'http://specs.openid.net/extensions/oauth/1.0'

[line 38]

URI of the OAuth namespace

Access: protected

Type:	string
Overrides:	Array

[ Top ]

$requestKeys = array('consumer', 'scope')

[line 52]

Supported keys in a request

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$responseKeys = array('request_token', 'scope')

[line 59]

Supported keys in a response

Access: protected

Type:	array
Overrides:	Array

[ Top ]

Method Detail

getAccessToken [line 80]

array getAccessToken(
string
$consumerKey, string
$consumerSecret, string
$url, [array
$params = array()], [string
$method = 'GET'])

Fetch an OAuth access token

Requires an request_token to be present in self::$values

Return: Key => Value array of token and token secret
See: http://step2.googlecode.com/svn/spec/openid_oauth_extension/latest/openid_oauth_extension.html
Throws: OpenID_Exception On no request_token in response message
Throws: HTTP_OAuth_Exception On issue with getting the request token
Access: public

Parameters:

string	`$consumerKey`	—	OAuth consumer application key
string	`$consumerSecret`	—	OAuth consumer secret key
string	`$url`	—	Access token url
array	`$params`	—	Paramters to include in the request for the access token
string	`$method`	—	HTTP Method to use

[ Top ]