API Documentation

Zend/Gdata/HttpClient.php

Show:

inherited

Classes
- \Zend_Gdata_HttpClient

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Gdata
Version: $Id: HttpClient.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_HttpClient
jump to top

Package: Zend\Gdata\Gdata

Gdata Http Client object.

Class to extend the generic Zend Http Client with the ability to perform secure AuthSub requests

Parent(s): \Zend_Http_Client
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

resource
                 $_authSubPrivateKeyId= 'null'

OpenSSL private key resource id This key is used for AuthSub authentication. If this value is set, it is assuemd that secure AuthSub is desired.

Default valuenullDetails

Type: resource

string
                 $_authSubToken= 'null'

Token for AuthSub authentication.

If this token is set, AuthSub authentication is used.

Default valuenullDetails

Type: string

string
                 $_clientLoginKey= 'null'

Token for ClientLogin authentication.

If this token is set, and the AuthSub key is not set, ClientLogin authentication is used

Default valuenullDetails

Type: string

string
                 $_clientLoginToken= 'null'

Token for ClientLogin authentication.

If only this token is set, ClientLogin authentication is used.

Default valuenullDetails

Type: string

bool
                 $_streamingRequest= 'null'

True if this request is being made with data supplied by a stream object instead of a raw encoded string.

Default valuenullDetails

Type: bool

Methods

_prepareBody(
          
          )
        
        :
          string

Prepare the request body (for POST and PUT requests)

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Http_Client_Exception

filterHttpRequest(
          string $method, string $url, array $headers
              =
              array(), string $body
              =
              null, string $contentType
              =
              null
          )
        
        :
          array

Filters the HTTP requests being sent to add the Authorization header.

If both AuthSub and ClientLogin tokens are set, AuthSub takes precedence. If an AuthSub key is set, then secure AuthSub authentication is used, and the request is signed. Requests must be signed only with the private key corresponding to the public key registered with Google. If an AuthSub key is set, but openssl support is not enabled in the PHP installation, an exception is thrown.

Parameters

Name	Type	Description
$method	string	The HTTP method
$url	string	The URL
$headers	array	An associate array of headers to be sent with the request or null
$body	string	The body of the request or null
$contentType	string	The MIME content type of the body or null

Returns

Type	Description
array	The processed values in an associative array, using the same names as the params

Throws

Exception	Description
\Zend_Gdata_App_Exception	if there was a signing failure

filterHttpResponse(
          \Zend_Http_Response $response
          )
        
        :
          \Zend_Http_Response

Method for filtering the HTTP response, though no filtering is currently done.

Parameters

Name	Type	Description
$response	\Zend_Http_Response	The response object to filter

Returns

Type	Description
\Zend_Http_Response	The filterd response object

getAdapter(
          
          )
        
        :
          \Zend_Http_Client_Adapter_Interface|string

Return the current connection adapter

Returns

Type	Description
\Zend_Http_Client_Adapter_Interface\|string	$adapter

getAuthSubPrivateKeyId(
          
          )
        
        :
          string

Gets the openssl private key id

Returns

Type	Description
string	The private key

getAuthSubToken(
          
          )
        
        :
          string

Gets the AuthSub token used for authentication

Returns

Type	Description
string	The token

getClientLoginToken(
          
          )
        
        :
          string

Gets the ClientLogin token used for authentication

Returns

Type	Description
string	The token

getStreamingRequest(
          
          )
        
        :
          boolean

Check whether the client is set to perform streaming requests.

Returns

Type	Description
boolean	True if yes, false otherwise.

resetParameters(
           $clearAll
              =
              false
          )
        
        :
          \Zend_Http_Client

Clear all custom parameters we set.

Parameters

Name	Type	Description
$clearAll

Returns

Type	Description
\Zend_Http_Client

setAdapter(
          \Zend_Http_Client_Adapter_Interface $adapter
          )
        
        :
          void

Load the connection adapter

Parameters

Name	Type	Description
$adapter	\Zend_Http_Client_Adapter_Interface

setAuthSubPrivateKey(
          string $key, string $passphrase
              =
              null
          )
        
        :
          \Zend_Gdata_HttpClient

Sets the PEM formatted private key to be used for secure AuthSub auth.

In order to call this method, openssl must be enabled in your PHP installation. Otherwise, a Zend_Gdata_App_InvalidArgumentException will be thrown.

Parameters

Name	Type	Description
$key	string	The private key
$passphrase	string	The optional private key passphrase

Returns

Type	Description
\Zend_Gdata_HttpClient	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

setAuthSubPrivateKeyFile(
          string $file, string $passphrase
              =
              null, bool $useIncludePath
              =
              false
          )
        
        :
          void

Sets the PEM formatted private key, as read from a file.

This method reads the file and then calls setAuthSubPrivateKey() with the file contents.

Parameters

Name	Type	Description
$file	string	The location of the file containing the PEM key
$passphrase	string	The optional private key passphrase
$useIncludePath	bool	Whether to search the include_path for the file

setAuthSubToken(
          string $token
          )
        
        :
          \Zend_Gdata_HttpClient

Sets the AuthSub token used for authentication

Parameters

Name	Type	Description
$token	string	The token

Returns

Type	Description
\Zend_Gdata_HttpClient	Provides a fluent interface

setClientLoginToken(
          string $token
          )
        
        :
          \Zend_Gdata_HttpClient

Sets the ClientLogin token used for authentication

Parameters

Name	Type	Description
$token	string	The token

Returns

Type	Description
\Zend_Gdata_HttpClient	Provides a fluent interface

setRawDataStream(
          string $data, string $enctype
              =
              null
          )
        
        :
          \Zend_Http_Client

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().

Parameters

Name	Type	Description
$data	string	The request data
$enctype	string	The encoding type

Returns

Type	Description
\Zend_Http_Client

setStreamingRequest(
          boolean $value
          )
        
        :
          void

Set the streamingRequest variable which controls whether we are sending the raw (already encoded) POST data from a stream source.

Parameters

Name	Type	Description
$value	boolean	The value to set.