Class JTwitterOAuth

Description

Joomla Platform class for generating Twitter API access token.

  • since: 12.3

Located in /libraries/joomla/twitter/oauth.php (line 20)

JOAuth1Client
   |
   --JTwitterOAuth
Variable Summary
Method Summary
 JTwitterOAuth __construct ([JRegistry $options = null], [JHttp $client = null], [JInput $input = null], [JApplicationWeb $application = null])
 array endSession ()
 void validateResponse (string $url, JHttpResponse $response)
 boolean verifyCredentials ()
Variables
JRegistry $options (line 26)
  • var: Options for the JTwitterOauth object.
  • since: 12.3
  • access: protected

Redefinition of:
JOAuth1Client::$options

Inherited Variables

Inherited from JOAuth1Client

JOAuth1Client::$application
JOAuth1Client::$client
JOAuth1Client::$input
JOAuth1Client::$token
JOAuth1Client::$version
Methods
Constructor __construct (line 38)

Constructor.

  • since: 12.3
  • access: public
JTwitterOAuth __construct ([JRegistry $options = null], [JHttp $client = null], [JInput $input = null], [JApplicationWeb $application = null])
  • JRegistry $options: JTwitterOauth options object.
  • JHttp $client: The HTTP client object.
  • JInput $input: The input object.
  • JApplicationWeb $application: The application object.

Redefinition of:
JOAuth1Client::__construct()
Constructor.
endSession (line 89)

Ends the session of the authenticating user, returning a null cookie.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array endSession ()
validateResponse (line 116)

Method to validate a response.

  • since: 12.3
  • throws: DomainException
  • access: public
void validateResponse (string $url, JHttpResponse $response)
  • string $url: The request URL.
  • JHttpResponse $response: The response to validate.

Redefinition of:
JOAuth1Client::validateResponse()
Method to validate a response.
verifyCredentials (line 58)

Method to verify if the access token is valid by making a request.

  • return: Returns true if the access token is valid and false otherwise.
  • since: 12.3
  • access: public
boolean verifyCredentials ()

Redefinition of:
JOAuth1Client::verifyCredentials()
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not.

Inherited Methods

Inherited From JOAuth1Client

 JOAuth1Client::__construct()
 JOAuth1Client::authenticate()
 JOAuth1Client::generateNonce()
 JOAuth1Client::getOption()
 JOAuth1Client::getToken()
 JOAuth1Client::oauthRequest()
 JOAuth1Client::safeEncode()
 JOAuth1Client::setOption()
 JOAuth1Client::setToken()
 JOAuth1Client::toUrl()
 JOAuth1Client::validateResponse()
 JOAuth1Client::verifyCredentials()

Documentation generated on Tue, 19 Nov 2013 15:09:40 +0100 by phpDocumentor 1.4.3