Gdata/App/LoggingHttpClientAdapterSocket.php
inherited
Classes
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 [email protected] 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
- App
- Version
- $Id: LoggingHttpClientAdapterSocket.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_App_LoggingHttpClientAdapterSocket
Overrides the traditional socket-based adapter class for Zend_Http_Client to enable logging of requests.
All requests are logged to a location specified in the config as $config['logfile']. Requests and responses are logged after they are sent and received/processed, thus an error could prevent logging.
- Parent(s)
- \Zend_Http_Client_Adapter_Socket
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
resource $_context = nullnullDetails- Type
- resource
- Inherited_from
- \Zend_Http_Client_Adapter_Socket::$$_context
array $config = array('persistent' => false, 'ssltransport' => 'ssl', 'sslcert' => null, 'sslpassphrase' => null, 'sslusecontext' => false)
array('persistent' => false, 'ssltransport' => 'ssl', 'sslcert' => null, 'sslpassphrase' => null, 'sslusecontext' => false)Details- Type
- array
- Inherited_from
- \Zend_Http_Client_Adapter_Socket::$$config
array $connected_to = array(null, null)What host/port are we connected to?
Inherited from: \Zend_Http_Client_Adapter_Socket::$$connected_toarray(null, null)Details- Type
- array
- Inherited_from
- \Zend_Http_Client_Adapter_Socket::$$connected_to
resource|null $log_handle = nullThe file handle for writing logs
nullDetails- Type
- resource | null
string $method = nullRequest method - will be set by write() and might be used by read()
Inherited from: \Zend_Http_Client_Adapter_Socket::$$methodnullDetails- Type
- string
- Inherited_from
- \Zend_Http_Client_Adapter_Socket::$$method
resource $out_stream = null
nullDetails- Type
- resource
- Inherited_from
- \Zend_Http_Client_Adapter_Socket::$$out_stream
resource|null $socket = null
nullDetails- Type
- resource | null
- Inherited_from
- \Zend_Http_Client_Adapter_Socket::$$socket
Methods
__construct() : voidAdapter constructor, currently empty.
Inherited from: \Zend_Http_Client_Adapter_Socket::__construct()Config is set using setConfig()
__destruct() : voidDestructor: make sure the socket is disconnected
Inherited from: \Zend_Http_Client_Adapter_Socket::__destruct()If we are in persistent TCP mode, will not close the connection
_checkSocketReadTimeout() : voidCheck 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() : voidClose the connection to the server
connect(string $host, int $port = 80, boolean $secure = false) : voidConnect to the remote server
| Name | Type | Description |
|---|---|---|
| $host | string | |
| $port | int | |
| $secure | boolean |
getConfig() : arrayRetrieve the array of all configuration options
Inherited from: \Zend_Http_Client_Adapter_Socket::getConfig()| Type | Description |
|---|---|
| array |
getStreamContext() : resourceGet 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 |
log(string $message) : voidLog the given message to the log file.
The log file is configured as the config param 'logfile'. This method opens the file for writing if necessary.
| Name | Type | Description |
|---|---|---|
| $message | string | The message to log |
read() : stringRead response from server
| Type | Description |
|---|---|
| string |
setConfig(\Zend_Config $config = array()) : voidSet 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_SocketSet 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_SocketSet 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 |
- Since
- Zend Framework 1.9
write(string $method, \Zend_Uri_Http $uri, string $http_ver = '1.1', array $headers = array(), string $body = '') : stringSend request to the remote server
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $uri | \Zend_Uri_Http | |
| $http_ver | string | |
| $headers | array | |
| $body | string |
| Type | Description |
|---|---|
| string | Request as string |