HTTP_OAuth
[ class tree: HTTP_OAuth ] [ index: HTTP_OAuth ] [ all elements ]
Packages:
HTTP_OAuth


Classes:
HTTP_OAuth
HTTP_OAuth_Consumer
HTTP_OAuth_Consumer_Exception_InvalidResponse
HTTP_OAuth_Consumer_Request
HTTP_OAuth_Consumer_Response
HTTP_OAuth_Exception
HTTP_OAuth_Exception_NotImplemented
HTTP_OAuth_Message
HTTP_OAuth_Provider_Exception
HTTP_OAuth_Provider_Exception_InvalidRequest
HTTP_OAuth_Provider_Request
HTTP_OAuth_Provider_Response
HTTP_OAuth_Signature
HTTP_OAuth_Signature_Common
HTTP_OAuth_Signature_HMAC_SHA1
HTTP_OAuth_Signature_PLAINTEXT
HTTP_OAuth_Signature_RSA_SHA1
HTTP_OAuth_Store_Consumer_CacheLite
HTTP_OAuth_Store_Data
Files:
access_token.php
authorize_url.php
CacheLite.php
cli.php
Common.php
config.php
Consumer.php
Data.php
examples-config.php
Exception.php
Exception.php
index.php
Interface.php
InvalidRequest.php
InvalidResponse.php
Message.php
NotImplemented.php
OAuth.php
oauth_request.php
PLAINTEXT.php
Request.php
Request.php
request_token.php
Response.php
Response.php
SHA1.php
SHA1.php
Signature.php
store.php

Class: HTTP_OAuth_Store_Consumer_Interface

Source Location: /HTTP_OAuth-0.3.1/HTTP/OAuth/Store/Consumer/Interface.php

Class Overview




A consumer storage interface for access tokens and request tokens.




Author(s):






          
                  


Copyright:


    
  
  • 2010 Bill Shupp
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 25]

A consumer storage interface for access tokens and request tokens.









[ Top ]








Method Detail



	
	
getAccessToken   [line 58]

	

    

    

		HTTP_OAuth_Data_Store getAccessToken(
string
$consumerUserID, string
$providerName)
    

    


	
		Gets access token data in the form of an HTTP_OAuth_Store_Data object


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $consumerUserID  
        — 
        The end user's ID at the consumer
      

          

        string  
        $providerName  
        — 
        The provider name (i.e. 'twitter')
      

        

    


        
[ Top ]

  

  
  
	
	
getRequestToken   [line 48]

	

    

    

		array getRequestToken(
string
$providerName, string
$sessionID)
    

    


	
		Gets a request token as an array of the token, tokenSecret, providerName,  and sessionID (array key names)


    

  • Return: on success, false on failure
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $providerName  
        — 
        The provider name (i.e. 'twitter')
      

          

        string  
        $sessionID  
        — 
        A string representing this user's session
      

        

    


        
[ Top ]

  

  
  
	
	
removeAccessToken   [line 76]

	

    

    

		bool removeAccessToken(
HTTP_OAuth_Store_Data
$data)
    

    


	
		Removes an access token


    

  • Return: true on success, false or PEAR_Error on failure
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        HTTP_OAuth_Store_Data  
        $data  
        — 
        The access token data
      

        

    


        
[ Top ]

  

  
  
	
	
setAccessToken   [line 67]

	

    

    

		bool setAccessToken(
HTTP_OAuth_Store_Data
$data)
    

    


	
		Sets access token data from an HTTP_OAuth_Store_Data object


    

  • Return: true on success, false on failure
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        HTTP_OAuth_Store_Data  
        $data  
        — 
        The access token data
      

        

    


        
[ Top ]

  

  
  
	
	
setRequestToken   [line 37]

	

    

    

		true setRequestToken(
string
$token, string
$tokenSecret, string
$providerName, string
$sessionID)
    

    


	
		Sets a request token


    

  • Return: on success, false or failure
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $token  
        — 
        The request token
      

          

        string  
        $tokenSecret  
        — 
        The request token secret
      

          

        string  
        $providerName  
        — 
        The name of the provider (i.e. 'twitter')
      

          

        string  
        $sessionID  
        — 
        A string representing this user's session
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:55:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.