Class Zend_Oauth_Http_Utility

Description
Description | Methods (details)
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Oauth/Http/Utility.php (line 34) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																																			
				

					 
					static 						string
										urlEncode
											(string $value)
									

																			
				

					 
											array
										assembleParams
											(string $url, Zend_Oauth_Config_ConfigInterface $config, [ $serviceProviderParams = null])
									

															
				

					 
											string
										generateNonce
										()
									

															
				

					 
											int
										generateTimestamp
										()
									

															
				

					 
											array
										parseQueryString
											(mixed $query)
									

															
				

					 
											string
										sign
											( $params, string $signatureMethod, string $consumerSecret, [null|string $tokenSecret = null], [null|string $method = null], [null|string $url = null])
									

															
				

					 
											void
										toAuthorizationHeader
											( $params, [null|string $realm = null], [bool $excludeCustomParams = true])
									

															
				

					 
											string
										toEncodedQueryString
											( $params, [bool $customParamsOnly = false])
									

																			

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		static urlEncode (line 211)
	
 
	
	

urlencode a value

	
    
				
  • access: public
    • 
			

	
	

		static string
		
			urlEncode
		
					(string $value)
			

	
			
    
					
  • 
				string
				$value			
    • 
				

		
			
	




	
	

		
		assembleParams (line 45)
	
 
	
	

Assemble all parameters for a generic OAuth request - i.e. no special  params other than the defaults expected for any OAuth query.

	
    
				
  • access: public
    • 
			

	
	

		array
		
			assembleParams
		
					(string $url, Zend_Oauth_Config_ConfigInterface $config, [ $serviceProviderParams = null])
			

	
			
		
			
	




	
	

		
		generateNonce (line 190)
	
 
	
	

Generate nonce

	
    
				
  • access: public
    • 
			

	
	

		string
		
			generateNonce
		
				()
			

	
		
			
	




	
	

		
		generateTimestamp (line 200)
	
 
	
	

Generate timestamp

	
    
				
  • access: public
    • 
			

	
	

		int
		
			generateTimestamp
		
				()
			

	
		
			
	




	
	

		
		parseQueryString (line 168)
	
 
	
	

Parse query string

	
    
				
  • access: public
    • 
			

	
	

		array
		
			parseQueryString
		
					(mixed $query)
			

	
			
    
					
  • 
				mixed
				$query			
    • 
				

		
			
	




	
	

		
		sign (line 144)
	
 
	
	

Sign request

	
    
				
  • access: public
    • 
			

	
	

		string
		
			sign
		
					( $params, string $signatureMethod, string $consumerSecret, [null|string $tokenSecret = null], [null|string $method = null], [null|string $url = null])
			

	
			
    
					
  • 
				array
				$params			
    • 
					
  • 
				string
				$signatureMethod			
    • 
					
  • 
				string
				$consumerSecret			
    • 
					
  • 
				null|string
				$tokenSecret			
    • 
					
  • 
				null|string
				$method			
    • 
					
  • 
				null|string
				$url			
    • 
				

		
			
	




	
	

		
		toAuthorizationHeader (line 114)
	
 
	
	

Cast to authorization header

	
    
				
  • access: public
    • 
			

	
	

		void
		
			toAuthorizationHeader
		
					( $params, [null|string $realm = null], [bool $excludeCustomParams = true])
			

	
			
    
					
  • 
				array
				$params			
    • 
					
  • 
				null|string
				$realm			
    • 
					
  • 
				bool
				$excludeCustomParams			
    • 
				

		
			
	




	
	

		
		toEncodedQueryString (line 88)
	
 
	
	

Given both OAuth parameters and any custom parametere, generate an  encoded query string. This method expects parameters to have been  assembled and signed beforehand.

	
    
				
  • access: public
    • 
			

	
	

		string
		
			toEncodedQueryString
		
					( $params, [bool $customParamsOnly = false])
			

	
			
    
					
  • 
				array
				$params			
    • 
					
  • 
				bool
				$customParamsOnly: Ignores OAuth params e.g. for requests using OAuth Header			
    • 
				

		
			
	

						
		

	


	
	

		Documentation generated on Mon, 21 Jun 2010 15:51:19 -0400 by phpDocumentor 1.4.3