Http/Client/Adapter/Proxy.php

Show:

inherited

Classes
- \Zend_Http_Client_Adapter_Proxy

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_Http
Subpackage: Client_Adapter
Version: $Id: Proxy.php 25273 2013-03-06 08:02:21Z frosch $

\Zend_Http_Client_Adapter_Proxy
jump to top

Package: Zend\Http\Client\Adapter

HTTP Proxy-supporting Zend_Http_Client adapter class, based on the default socket based adapter.

Should be used if proxy HTTP access is required. If no proxy is set, will fall back to Zend_Http_Client_Adapter_Socket behavior. Just like the default Socket adapter, this adapter does not require any special extensions installed.

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

Properties

resource $_context = null

inherited

Stream context

Inherited from: \Zend_Http_Client_Adapter_Socket::$$_context

Default valuenullDetails

Type: resource
Inherited_from: \Zend_Http_Client_Adapter_Socket::$$_context

array $config = array('ssltransport' => 'ssl', 'sslcert' => null, 'sslpassphrase' => null, 'sslusecontext' => false, 'proxy_host' => '', 'proxy_port' => 8080, 'proxy_user' => '', 'proxy_pass' => '', 'proxy_auth' => \Zend_Http_Client::AUTH_BASIC, 'persistent' => false)

Parameters array

Default value

array('ssltransport' => 'ssl', 'sslcert' => null, 'sslpassphrase' => null, 'sslusecontext' => false, 'proxy_host' => '', 'proxy_port' => 8080, 'proxy_user' => '', 'proxy_pass' => '', 'proxy_auth' => \Zend_Http_Client::AUTH_BASIC, 'persistent' => false)

Details

Type: array

string $connectHandshakeRequest

Stores the last CONNECT handshake request

Details

Type: string

array $connected_to = array(null, null)

inherited

What host/port are we connected to?

Inherited from: \Zend_Http_Client_Adapter_Socket::$$connected_to

Default valuearray(null, null)Details

Type: array
Inherited_from: \Zend_Http_Client_Adapter_Socket::$$connected_to

string $method = null

inherited

Request method - will be set by write() and might be used by read()

Inherited from: \Zend_Http_Client_Adapter_Socket::$$method

Default valuenullDetails

Type: string
Inherited_from: \Zend_Http_Client_Adapter_Socket::$$method

boolean $negotiated = false

Whether HTTPS CONNECT was already negotiated with the proxy or not

Default valuefalseDetails

Type: boolean

resource $out_stream = null

inherited

Stream for storing output

Inherited from: \Zend_Http_Client_Adapter_Socket::$$out_stream

Default valuenullDetails

Type: resource
Inherited_from: \Zend_Http_Client_Adapter_Socket::$$out_stream

resource|null $socket = null

inherited

The socket for server connection

Inherited from: \Zend_Http_Client_Adapter_Socket::$$socket

Default valuenullDetails

Type: resource | null
Inherited_from: \Zend_Http_Client_Adapter_Socket::$$socket

Methods

__construct() : void

inherited

Adapter constructor, currently empty.

Inherited from: \Zend_Http_Client_Adapter_Socket::__construct()

Config is set using setConfig()

__destruct() : void

Destructor: make sure the socket is disconnected

If we are in persistent TCP mode, will not close the connection

_checkSocketReadTimeout() : void

inherited

Check if the socket has timed out - if so close connection and throw an exception

Inherited from: \Zend_Http_Client_Adapter_Socket::_checkSocketReadTimeout()

Throws

Exception	Description
\Zend_Http_Client_Adapter_Exception	with READ_TIMEOUT code

close() : void

Close the connection to the server

connect(string $host, int $port = 80, boolean $secure = false) : void

Connect to the remote server

Will try to connect to the proxy server. If no proxy was set, will fall back to the target server (behave like regular Socket adapter)

Parameters

Name	Type	Description
$host	string
$port	int
$secure	boolean

connectHandshake(string $host, integer $port = 443, string $http_ver = '1.1', array $headers = array()) : void

Preform handshaking with HTTPS proxy using CONNECT method

Parameters

Name	Type	Description
$host	string
$port	integer
$http_ver	string
$headers	array

Throws

Exception	Description
\Zend_Http_Client_Adapter_Exception

getConfig() : array

inherited

Retrieve the array of all configuration options

Inherited from: \Zend_Http_Client_Adapter_Socket::getConfig()

Returns

Type	Description
array

getStreamContext() : resource

inherited

Get the stream context for the TCP connection to the server.

Inherited from: \Zend_Http_Client_Adapter_Socket::getStreamContext()

If no stream context is set, will create a default one.

Returns

Type	Description
resource

read() : string

inherited

Read response from server

Inherited from: \Zend_Http_Client_Adapter_Socket::read()

Returns

Type	Description
string

setConfig(\Zend_Config $config = array()) : void

inherited

Set the configuration array for the adapter

Inherited from: \Zend_Http_Client_Adapter_Socket::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config	\| array $config

setOutputStream(resource $stream) : \Zend_Http_Client_Adapter_Socket

inherited

Set output stream for the response

Inherited from: \Zend_Http_Client_Adapter_Socket::setOutputStream()

This function sets output stream where the result will be stored.

Parameters

Name	Type	Description
$stream	resource

Returns

Type	Description
\Zend_Http_Client_Adapter_Socket

setStreamContext(mixed $context) : \Zend_Http_Client_Adapter_Socket

inherited

Set the stream context for the TCP connection to the server

Inherited from: \Zend_Http_Client_Adapter_Socket::setStreamContext()

Can accept either a pre-existing stream context resource, or an array of stream options, similar to the options array passed to the stream_context_create() PHP function. In such case a new stream context will be created using the passed options.

Parameters

Name	Type	Description
$context	mixed	Stream context or array of context options

Returns

Type	Description
\Zend_Http_Client_Adapter_Socket

Details

Since: Zend Framework 1.9

write(string $method, \Zend_Uri_Http $uri, string $http_ver = '1.1', array $headers = array(), string $body = '') : string

Send request to the proxy server

Parameters

Name	Type	Description
$method	string
$uri	\Zend_Uri_Http
$http_ver	string
$headers	array
$body	string

Returns

Type	Description
string	Request as string

Throws

Exception	Description
\Zend_Http_Client_Adapter_Exception

Http/Client/Adapter/Proxy.php

\Zend_Http_Client_Adapter_Proxyjump to top

Properties

Methods

\Zend_Http_Client_Adapter_Proxy
jump to top