Http/Client/Adapter/Curl.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_Http
- Subpackage
- Client_Adapter
- Version
- $Id: Curl.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Http_Client_Adapter_Curl
An adapter class for Zend_Http_Client based on the curl extension.
Curl requires libcurl. See for full requirements the PHP manual: http://php.net/curl
- Implements
- \Zend_Http_Client_Adapter_Interface
- \Zend_Http_Client_Adapter_Stream
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_config = array()Parameters array
array()Details- Type
- array
array $_connected_to = array(null, null)What host/port are we connected to?
array(null, null)Details- Type
- array
resource|null $_curl = nullThe curl session handle
nullDetails- Type
- resource | null
array $_invalidOverwritableCurlOptions = List of cURL options that should never be overwritten
- Type
- array
string $_response = nullResponse gotten from server
nullDetails- Type
- string
resource $out_stream = Stream for storing output
- Type
- resource
Methods
__construct() : voidAdapter constructor
Config is set using setConfig()
| Exception | Description |
|---|---|
| \Zend_Http_Client_Adapter_Exception |
close() : voidClose the connection to the server
connect(string $host, int $port = 80, boolean $secure = false) : voidInitialize curl
| Name | Type | Description |
|---|---|---|
| $host | string | |
| $port | int | |
| $secure | boolean |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Adapter_Exception | if unable to connect |
getConfig() : arrayRetrieve the array of all configuration options
| Type | Description |
|---|---|
| array |
getHandle() : resourceGet cUrl Handle
| Type | Description |
|---|---|
| resource |
read() : stringReturn read response from server
| Type | Description |
|---|---|
| string |
readHeader(resource $curl, string $header) : intHeader reader function for CURL
| Name | Type | Description |
|---|---|---|
| $curl | resource | |
| $header | string |
| Type | Description |
|---|---|
| int |
setConfig(\Zend_Config $config = array()) : \Zend_Http_Client_Adapter_CurlSet the configuration array for the adapter
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config | | array $config |
| Type | Description |
|---|---|
| \Zend_Http_Client_Adapter_Curl |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Adapter_Exception |
setCurlOption(string | int $option, mixed $value) : \Zend_Http_Adapter_CurlDirect setter for cURL adapter related options.
| Name | Type | Description |
|---|---|---|
| $option | string | int | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Http_Adapter_Curl |
setOutputStream(resource $stream) : \Zend_Http_Client_Adapter_SocketSet output stream for the response
This function sets output stream where the result will be stored.
| Name | Type | Description |
|---|---|---|
| $stream | resource |
| Type | Description |
|---|---|
| \Zend_Http_Client_Adapter_Socket |
write(string $method, \Zend_Uri_Http $uri, $httpVersion = 1.1, array $headers = array(), string $body = '') : stringSend request to the remote server
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $uri | \Zend_Uri_Http | |
| $httpVersion | ||
| $headers | array | |
| $body | string |
| Type | Description |
|---|---|
| string | $request |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Adapter_Exception | If connection fails, connected to wrong host, no PUT file defined, unsupported method, or unsupported cURL option |