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.
Extends the proxy HTTP adapter to handle streams instead of discrete body strings.
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.

__construct(
)
:
void
Adapter constructor, currently empty. Config is set using setConfig()
Inherited from: \Zend_Http_Client_Adapter_Socket::__construct()
__destruct(
)
:
void
Destructor: make sure the socket is disconnected
Inherited from: \Zend_Http_Client_Adapter_Proxy::__destruct()If we are in persistent TCP mode, will not close the connection

_checkSocketReadTimeout(
)
:
void
Check if the socket has timed out - if so close connection and throw an exception
Inherited from: \Zend_Http_Client_Adapter_Socket::_checkSocketReadTimeout()Exception | Description |
---|---|
\Zend_Http_Client_Adapter_Exception | with READ_TIMEOUT code |

close(
)
:
void
Close the connection to the server
Inherited from: \Zend_Http_Client_Adapter_Proxy::close()
connect(
string $host, int $port
=
80, boolean $secure
=
false
)
:
void
Connect to the remote server
Inherited from: \Zend_Http_Client_Adapter_Proxy::connect()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)
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
Inherited from: \Zend_Http_Client_Adapter_Proxy::connectHandshake()Name | Type | Description |
---|---|---|
$host | string | |
$port | integer | |
$http_ver | string | |
$headers | array |

getConfig(
)
:
array
Retrieve the array of all configuration options
Inherited from: \Zend_Http_Client_Adapter_Socket::getConfig()Type | Description |
---|---|
array |

getStreamContext(
)
:
resource
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.
Type | Description |
---|---|
resource |

read(
)
:
string
Read response from server
Inherited from: \Zend_Http_Client_Adapter_Socket::read()Type | Description |
---|---|
string |

setConfig(
\Zend_Config $config
=
array
)
:
void
Set the configuration array for the adapter
Inherited from: \Zend_Http_Client_Adapter_Socket::setConfig()Name | Type | Description |
---|---|---|
$config | \Zend_Config | | array $config |

setOutputStream(
resource $stream
)
:
\Zend_Http_Client_Adapter_Socket
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.
Name | Type | Description |
---|---|---|
$stream | resource |
Type | Description |
---|---|
\Zend_Http_Client_Adapter_Socket |

setStreamContext(
mixed $context
)
:
\Zend_Http_Client_Adapter_Socket
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.
Name | Type | Description |
---|---|---|
$context | mixed | Stream context or array of context options |
Type | Description |
---|---|
\Zend_Http_Client_Adapter_Socket |

write(
string $method, \Zend_Uri_Http $uri, string $http_ver
=
1.1, array $headers
=
array, string $body
)
:
string
Send request to the proxy server with streaming support
Name | Type | Description |
---|---|---|
$method | string | |
$uri | \Zend_Uri_Http | |
$http_ver | string | |
$headers | array | |
$body | string |
Type | Description |
---|---|
string | Request as string |