## API Documentation

# Http/Client/Adapter/Curl.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
package
  Zend_Http
subpackage
  Client_Adapter
version
  $Id: Curl.php 24272 2011-07-27 21:12:08Z mcleod@spaceweb.nl $

## \Zend_Http_Client_Adapter_Curl
jump to top

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-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
package
  Zend_Http
subpackage
  Client_Adapter

### Properties

`array $_config= 'array'`

Parameters array

Default value `array` Details

Type
  array

`array $_connected_to= 'array'`

What host/port are we connected to?

Default value `array` Details

Type
  array

`resource|null $_curl= 'null'`

The curl session handle

Default value `null` Details

Type
  resourcenull

`array $_invalidOverwritableCurlOptions= ''`

List of cURL options that should never be overwritten

Details

Type
  array

`string $_response= 'null'`

Response gotten from server

Default value `null` Details

Type
  string

`resource $out_stream= ''`

Stream for storing output

Details

Type
  resource

### Methods

`__construct( ) : void`

Adapter constructor

Config is set using setConfig()

Throws

Exception | Description
--- | ---
\Zend_Http_Client_Adapter_Exception |

`close( ) : void`

Close the connection to the server

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

Initialize curl

Parameters

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

Throws

Exception | Description
--- | ---
\Zend_Http_Client_Adapter_Exception | if unable to connect

`getConfig( ) : array`

Retrieve the array of all configuration options

Returns

Type | Description
--- | ---
array |

`getHandle( ) : resource`

Get cUrl Handle

Returns

Type | Description
--- | ---
resource |

`read( ) : string`

Return read response from server

Returns

Type | Description
--- | ---
string |

`readHeader( resource $curl, string $header ) : int`

Header reader function for CURL

Parameters

Name | Type | Description
--- | --- | ---
$curl | resource |
$header | string |

Returns

Type | Description
--- | ---
int |

`setConfig( \Zend_Config $config = array ) : \Zend_Http_Client_Adapter_Curl`

Set the configuration array for the adapter

Parameters

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

Returns

Type | Description
--- | ---
\Zend_Http_Client_Adapter_Curl |

Throws

Exception | Description
--- | ---
\Zend_Http_Client_Adapter_Exception |

`setCurlOption( string|int $option, mixed $value ) : \Zend_Http_Adapter_Curl`

Direct setter for cURL adapter related options.

Parameters

Name | Type | Description
--- | --- | ---
$option | string|int |
$value | mixed |

Returns

Type | Description
--- | ---
\Zend_Http_Adapter_Curl |

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

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

Send request to the remote server

Parameters

Name | Type | Description
--- | --- | ---
$method | string |
$uri | \Zend_Uri_Http |
$httpVersion |  |
$headers | array |
$body | string |

Returns

Type | Description
--- | ---
string | $request

Throws

Exception | Description
--- | ---
\Zend_Http_Client_Adapter_Exception | If connection fails, connected to wrong host, no PUT file defined, unsupported method, or unsupported cURL option

Documentation was generated by DocBlox 0.13.3.