[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/include/Zend/Oauth/ -> Client.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: Client.php 24593 2012-01-05 20:35:02Z matthew $
File Size: 334 lines (11 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 5 files
 include/Zend/Oauth/Exception.php
 include/Zend/Oauth/Http/Utility.php
 include/Zend/Oauth.php
 include/Zend/Http/Client.php
 include/Zend/Oauth/Config.php

Defines 1 class

Zend_Oauth_Client:: (12 methods):
  __construct()
  setAdapter()
  setStreamingRequest()
  getStreamingRequest()
  _prepareBody()
  resetParameters()
  setRawDataStream()
  setMethod()
  request()
  prepareOauth()
  _getSignableParametersAsQueryString()
  __call()


Class: Zend_Oauth_Client  - X-Ref


__construct($oauthOptions, $uri = null, $config = null)   X-Ref
Constructor; creates a new HTTP Client instance which itself is
just a typical Zend_Http_Client subclass with some OAuth icing to
assist in automating OAuth parameter generation, addition and
cryptographioc signing of requests.

param: array|Zend_Config $oauthOptions
param: string            $uri
param: array|Zend_Config $config
return: void

setAdapter($adapter)   X-Ref
Load the connection adapter

param: Zend_Http_Client_Adapter_Interface $adapter
return: void

setStreamingRequest($value)   X-Ref
Set the streamingRequest variable which controls whether we are
sending the raw (already encoded) POST data from a stream source.

param: boolean $value The value to set.
return: void

getStreamingRequest()   X-Ref
Check whether the client is set to perform streaming requests.

return: boolean True if yes, false otherwise.

_prepareBody()   X-Ref
Prepare the request body (for POST and PUT requests)

return: string

resetParameters($clearAll = false)   X-Ref
Clear all custom parameters we set.

return: Zend_Http_Client

setRawDataStream($data, $enctype = null)   X-Ref
Set the raw (already encoded) POST data from a stream source.

This is used to support POSTing from open file handles without
caching the entire body into memory. It is a wrapper around
Zend_Http_Client::setRawData().

param: string $data The request data
param: string $enctype The encoding type
return: Zend_Http_Client

setMethod($method = self::GET)   X-Ref
Same as Zend_Http_Client::setMethod() except it also creates an
Oauth specific reference to the method type.
Might be defunct and removed in a later iteration.

param: string $method
return: Zend_Http_Client

request($method = null)   X-Ref
Same as Zend_Http_Client::request() except just before the request is
executed, we automatically append any necessary OAuth parameters and
sign the request using the relevant signature method.

param: string $method
return: Zend_Http_Response

prepareOauth()   X-Ref
Performs OAuth preparation on the request before sending.

This primarily means taking a request, correctly encoding and signing
all parameters, and applying the correct OAuth scheme to the method
being used.

return: void

_getSignableParametersAsQueryString()   X-Ref
Collect all signable parameters into a single array across query string
and POST body. These are returned as a properly formatted single
query string.

return: string

__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