Http/Client/Adapter/Socket.php

Show:

inherited

Classes
- \Zend_Http_Client_Adapter_Socket

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: Socket.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Http_Client_Adapter_Socket
jump to top

Package: Zend\Http\Client\Adapter

A sockets based (stream_socket_client) adapter class for Zend_Http_Client.

Can be used on almost every PHP environment, and does not require any special extensions.

Implements: \Zend_Http_Client_Adapter_Interface; \Zend_Http_Client_Adapter_Stream
Children: \Zend_Http_Client_Adapter_Proxy; \Zend_Gdata_App_LoggingHttpClientAdapterSocket; \Zend_Gdata_HttpAdapterStreamingSocket
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

resource $_context = null

Stream context

Default valuenullDetails

Type: resource

array $config = array('persistent' => false, 'ssltransport' => 'ssl', 'sslcert' => null, 'sslpassphrase' => null, 'sslusecontext' => false)

Parameters array

Default value

array('persistent' => false, 'ssltransport' => 'ssl', 'sslcert' => null, 'sslpassphrase' => null, 'sslusecontext' => false)

Details

Type: array

array $connected_to = array(null, null)

What host/port are we connected to?

Default valuearray(null, null)Details

Type: array

string $method = null

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

Default valuenullDetails

Type: string

resource $out_stream = null

Stream for storing output

Default valuenullDetails

Type: resource

resource|null $socket = null

The socket for server connection

Default valuenullDetails

Type: resource | null

Methods

__construct() : void

Adapter constructor, currently empty.

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

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

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

Parameters

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

getConfig() : array

Retrieve the array of all configuration options

Returns

Type	Description
array

getStreamContext() : resource

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

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

Returns

Type	Description
resource

read() : string

Read response from server

Returns

Type	Description
string

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

Set the configuration array for the adapter

Parameters

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

setOutputStream(resource $stream) : \Zend_Http_Client_Adapter_Socket

Set output stream for the response

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

Set the stream context for the TCP connection to the server

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 remote 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

Http/Client/Adapter/Socket.php

\Zend_Http_Client_Adapter_Socketjump to top

Properties

Methods

\Zend_Http_Client_Adapter_Socket
jump to top