[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/include/Zend/Oauth/ -> Consumer.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id: Consumer.php 24593 2012-01-05 20:35:02Z matthew $
File Size: 280 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 8 files
 include/Zend/Oauth/Http/RequestToken.php
 include/Zend/Oauth.php
 include/Zend/Oauth/Config.php
 include/Zend/Uri.php
 include/Zend/Oauth/Http/AccessToken.php
 include/Zend/Oauth/Http/UserAuthorization.php
 include/Zend/Oauth/Exception.php
 include/Zend/Oauth/Token/AuthorizedRequest.php

Defines 1 class

Zend_Oauth_Consumer:: (9 methods):
  __construct()
  getRequestToken()
  getRedirectUrl()
  redirect()
  getAccessToken()
  getLastRequestToken()
  getLastAccessToken()
  getToken()
  __call()


Class: Zend_Oauth_Consumer  - X-Ref


__construct($options = null)   X-Ref
Constructor; create a new object with an optional array|Zend_Config
instance containing initialising options.

param: array|Zend_Config $options
return: void

getRequestToken(array $customServiceParameters = null,$httpMethod = null,Zend_Oauth_Http_RequestToken $request = null)   X-Ref
Attempts to retrieve a Request Token from an OAuth Provider which is
later exchanged for an authorized Access Token used to access the
protected resources exposed by a web service API.

param: null|array $customServiceParameters Non-OAuth Provider-specified parameters
param: null|string $httpMethod
param: null|Zend_Oauth_Http_RequestToken $request
return: Zend_Oauth_Token_Request

getRedirectUrl(array $customServiceParameters = null,Zend_Oauth_Token_Request $token = null,Zend_Oauth_Http_UserAuthorization $redirect = null)   X-Ref
After a Request Token is retrieved, the user may be redirected to the
OAuth Provider to authorize the application's access to their
protected resources - the redirect URL being provided by this method.
Once the user has authorized the application for access, they are
redirected back to the application which can now exchange the previous
Request Token for a fully authorized Access Token.

param: null|array $customServiceParameters
param: null|Zend_Oauth_Token_Request $token
param: null|Zend_OAuth_Http_UserAuthorization $redirect
return: string

redirect(array $customServiceParameters = null,Zend_Oauth_Token_Request $token = null,Zend_Oauth_Http_UserAuthorization $request = null)   X-Ref
Rather than retrieve a redirect URL for use, e.g. from a controller,
one may perform an immediate redirect.

Sends headers and exit()s on completion.

param: null|array $customServiceParameters
param: null|Zend_Oauth_Token_Request $token
param: null|Zend_Oauth_Http_UserAuthorization $request
return: void

getAccessToken($queryData,Zend_Oauth_Token_Request $token,$httpMethod = null,Zend_Oauth_Http_AccessToken $request = null)   X-Ref
Retrieve an Access Token in exchange for a previously received/authorized
Request Token.

param: array $queryData GET data returned in user's redirect from Provider
param: Zend_Oauth_Token_Request Request Token information
param: string $httpMethod
param: Zend_Oauth_Http_AccessToken $request
return: Zend_Oauth_Token_Access

getLastRequestToken()   X-Ref
Return whatever the last Request Token retrieved was while using the
current Consumer instance.

return: Zend_Oauth_Token_Request

getLastAccessToken()   X-Ref
Return whatever the last Access Token retrieved was while using the
current Consumer instance.

return: Zend_Oauth_Token_Access

getToken()   X-Ref
Alias to self::getLastAccessToken()

return: Zend_Oauth_Token_Access

__call($method, array $args)   X-Ref
Simple Proxy to the current Zend_Oauth_Config method. It's that instance
which holds all configuration methods and values this object also presents
as it's API.

param: string $method
param: array $args
return: mixed



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1