soap_transport_http Class Reference

Inherits nusoap_base, and nusoap_base.

Inheritance diagram for soap_transport_http:

[legend]
Collaboration diagram for soap_transport_http:
[legend]
List of all members.

Public Member Functions

 soap_transport_http ($url)
 send ($data, $timeout=0, $response_timeout=30, $cookies=NULL)
 sendHTTPS ($data, $timeout=0, $response_timeout=30, $cookies)
 setCredentials ($username, $password, $authtype= 'basic', $digestRequest=array(), $certRequest=array())
 setSOAPAction ($soapaction)
 setEncoding ($enc='gzip, deflate')
 setProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '')
 decodeChunked ($buffer, $lb)
 parseCookie ($cookie_str)
 getCookiesForRequest ($cookies, $secure=false)
 soap_transport_http ($url)
 send ($data, $timeout=0, $response_timeout=30, $cookies=NULL)
 sendHTTPS ($data, $timeout=0, $response_timeout=30, $cookies)
 setCredentials ($username, $password, $authtype= 'basic', $digestRequest=array(), $certRequest=array())
 setSOAPAction ($soapaction)
 setEncoding ($enc='gzip, deflate')
 setProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '')
 decodeChunked ($buffer, $lb)
 parseCookie ($cookie_str)
 getCookiesForRequest ($cookies, $secure=false)

Detailed Description

transport class for sending/receiving data via HTTP and HTTPS NOTE: PHP must be compiled with the CURL extension for HTTPS support

Author:
Dietrich Ayala <dietrich@ganx4.com>
Version:
$Id$ public


Member Function Documentation

soap_transport_http::soap_transport_http ( url  ) 

constructor

soap_transport_http::send ( data,
timeout = 0,
response_timeout = 30,
cookies = NULL 
)

send the SOAP message via HTTP

Parameters:
string $data message data
integer $timeout set connection timeout in seconds
integer $response_timeout set response timeout in seconds
array $cookies cookies to send
Returns:
string data public

soap_transport_http::sendHTTPS ( data,
timeout = 0,
response_timeout = 30,
cookies 
)

send the SOAP message via HTTPS 1.0 using CURL

Parameters:
string $msg message data
integer $timeout set connection timeout in seconds
integer $response_timeout set response timeout in seconds
array $cookies cookies to send
Returns:
string data public

soap_transport_http::setCredentials ( username,
password,
authtype = 'basic',
digestRequest = array(),
certRequest = array() 
)

if authenticating, set user credentials here

Parameters:
string $username
string $password
string $authtype (basic, digest, certificate)
array $digestRequest (keys must be nonce, nc, realm, qop)
array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public

soap_transport_http::setSOAPAction ( soapaction  ) 

set the soapaction value

Parameters:
string $soapaction public

soap_transport_http::setEncoding ( enc = 'gzip,
deflate'   
)

use http encoding

Parameters:
string $enc encoding style. supported values: gzip, deflate, or both public

soap_transport_http::setProxy ( proxyhost,
proxyport,
proxyusername = '',
proxypassword = '' 
)

set proxy info here

Parameters:
string $proxyhost
string $proxyport
string $proxyusername
string $proxypassword public

soap_transport_http::decodeChunked ( buffer,
lb 
)

decode a string that is encoded w/ "chunked' transfer encoding as defined in RFC2068 19.4.6

Parameters:
string $buffer
string $lb
Returns:
string public
Deprecated:

soap_transport_http::parseCookie ( cookie_str  ) 

parse an incoming Cookie into it's parts

Parameters:
string $cookie_str content of cookie
Returns:
array with data of that cookie private

soap_transport_http::getCookiesForRequest ( cookies,
secure = false 
)

sort out cookies for the current request

Parameters:
array $cookies array with all cookies
boolean $secure is the send-content secure or not?
Returns:
string for Cookie-HTTP-Header private

soap_transport_http::soap_transport_http ( url  ) 

constructor

soap_transport_http::send ( data,
timeout = 0,
response_timeout = 30,
cookies = NULL 
)

send the SOAP message via HTTP

Parameters:
string $data message data
integer $timeout set connection timeout in seconds
integer $response_timeout set response timeout in seconds
array $cookies cookies to send
Returns:
string data public

soap_transport_http::sendHTTPS ( data,
timeout = 0,
response_timeout = 30,
cookies 
)

send the SOAP message via HTTPS 1.0 using CURL

Parameters:
string $msg message data
integer $timeout set connection timeout in seconds
integer $response_timeout set response timeout in seconds
array $cookies cookies to send
Returns:
string data public

soap_transport_http::setCredentials ( username,
password,
authtype = 'basic',
digestRequest = array(),
certRequest = array() 
)

if authenticating, set user credentials here

Parameters:
string $username
string $password
string $authtype (basic, digest, certificate)
array $digestRequest (keys must be nonce, nc, realm, qop)
array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public

soap_transport_http::setSOAPAction ( soapaction  ) 

set the soapaction value

Parameters:
string $soapaction public

soap_transport_http::setEncoding ( enc = 'gzip,
deflate'   
)

use http encoding

Parameters:
string $enc encoding style. supported values: gzip, deflate, or both public

soap_transport_http::setProxy ( proxyhost,
proxyport,
proxyusername = '',
proxypassword = '' 
)

set proxy info here

Parameters:
string $proxyhost
string $proxyport
string $proxyusername
string $proxypassword public

soap_transport_http::decodeChunked ( buffer,
lb 
)

decode a string that is encoded w/ "chunked' transfer encoding as defined in RFC2068 19.4.6

Parameters:
string $buffer
string $lb
Returns:
string public
Deprecated:

soap_transport_http::parseCookie ( cookie_str  ) 

parse an incoming Cookie into it's parts

Parameters:
string $cookie_str content of cookie
Returns:
array with data of that cookie private

soap_transport_http::getCookiesForRequest ( cookies,
secure = false 
)

sort out cookies for the current request

Parameters:
array $cookies array with all cookies
boolean $secure is the send-content secure or not?
Returns:
string for Cookie-HTTP-Header private


The documentation for this class was generated from the following files:
Generated on Thu Nov 2 00:27:18 2006 for XOOPS Cube Legacy by  doxygen 1.5.1