Http/Client/Adapter/Curl.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Http
subpackage: Client_Adapter
version: $Id: Curl.php 22221 2010-05-21 07:00:58Z dragonbe $
Classes: Zend_Http_Client_Adapter_Curl

Description

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.

Zend_Http_Client_Adapter_Curl
jump to top

Implements: Zend_Http_Client_Adapter_Interface; Zend_Http_Client_Adapter_Stream
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Http
subpackage: Client_Adapter
Properties: $_config; $_connected_to; $_curl; $_invalidOverwritableCurlOptions; $_response; $out_stream
Methods: __construct; setConfig; getConfig; setCurlOption; connect; write; read; close; getHandle; setOutputStream; readHeader

Description

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

Properties

$_config
jump to class

array $_config = 'array'

Parameters array

Details

$_config: array
visibility: protected
default: array
final: false
static: false

$_connected_to
jump to class

array $_connected_to = 'array'

What host/port are we connected to?

Details

$_connected_to: array
visibility: protected
default: array
final: false
static: false

$_curl
jump to class

resource|null $_curl = 'null'

The curl session handle

Details

$_curl: resource|null
visibility: protected
default: null
final: false
static: false

$_invalidOverwritableCurlOptions
jump to class

array $_invalidOverwritableCurlOptions = ''

List of cURL options that should never be overwritten

Details

$_invalidOverwritableCurlOptions: array
visibility: protected
default
final: false
static: false

$_response
jump to class

string $_response = 'null'

Response gotten from server

Details

$_response: string
visibility: protected
default: null
final: false
static: false

$out_stream
jump to class

resource $out_stream = ''

Stream for storing output

Details

$out_stream: resource
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :
        void

Adapter constructor

Config is set using setConfig()

Details

visibility: public
final: false
static: false
throws

close
jump to class

Close the connection to the server

Details

visibility: public
final: false
static: false

connect
jump to class

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

Initialize curl

Arguments

$host: string
$port: int
$secure: boolean

Details

visibility: public
final: false
static: false
throws: if unable to connect

getConfig
jump to class

getConfig(
          
          )
        
        :
        array

Retrieve the array of all configuration options

Output

array

Details

visibility: public
final: false
static: false

getHandle
jump to class

getHandle(
          
          )
        
        :
        resource

Get cUrl Handle

Output

resource

Details

visibility: public
final: false
static: false

read
jump to class

read(
          
          )
        
        :
        string

Return read response from server

Output

string

Details

visibility: public
final: false
static: false

readHeader
jump to class

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

Header reader function for CURL

Arguments

$curl: resource
$header: string

Output

int

Details

visibility: public
final: false
static: false

setConfig
jump to class

setConfig(
          Zend_Config $config
              =
              array
          )
        
        :
        Zend_Http_Client_Adapter_Curl

Set the configuration array for the adapter

Arguments

$config: Zend_Config
| array $config

Output

Zend_Http_Client_Adapter_Curl

Details

visibility: public
final: false
static: false
throws

setCurlOption
jump to class

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

Direct setter for cURL adapter related options.

Arguments

$option: stringint
$value: mixed

Output

Zend_Http_Adapter_Curl

Details

visibility: public
final: false
static: false

setOutputStream
jump to class

setOutputStream(
          resource $stream
          )
        
        :
        Zend_Http_Client_Adapter_Socket

Set output stream for the response

Arguments

$stream: resource

Output

Zend_Http_Client_Adapter_Socket

Details

visibility: public
final: false
static: false

write
jump to class

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

Send request to the remote server

Arguments

$method: string
$uri: Zend_Uri_Http
$httpVersion
$headers: array
$body: string

Output

string: $request

Details

visibility: public
final: false
static: false
throws: If connection fails, connected to wrong host, no PUT file defined, unsupported method, or unsupported cURL option

API Documentation

Http/Client/Adapter/Curl.php

Description

Zend_Http_Client_Adapter_Curljump to top

Description

Properties

$_configjump to class

Details

$_connected_tojump to class

Details

$_curljump to class

Details

$_invalidOverwritableCurlOptionsjump to class

Details

$_responsejump to class

Details

$out_streamjump to class

Details

Methods

__constructjump to class

Details

closejump to class

Details

connectjump to class

Arguments

Details

getConfigjump to class

Output

Details

getHandlejump to class

Output

Details

readjump to class

Output

Details

readHeaderjump to class

Arguments

Output

Details

setConfigjump to class

Arguments

Output

Details

setCurlOptionjump to class

Arguments

Output

Details

setOutputStreamjump to class

Arguments

Output

Details

writejump to class

Arguments

Output

Details

Zend_Http_Client_Adapter_Curl
jump to top

$_config
jump to class

$_connected_to
jump to class

$_curl
jump to class

$_invalidOverwritableCurlOptions
jump to class

$_response
jump to class

$out_stream
jump to class

__construct
jump to class

close
jump to class

connect
jump to class

getConfig
jump to class

getHandle
jump to class

read
jump to class

readHeader
jump to class

setConfig
jump to class

setCurlOption
jump to class

setOutputStream
jump to class

write
jump to class