Class: soap_transport_http

Source Location: /lodel/scripts/nusoap.php

Class soap_transport_http

Class Overview

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

Located in /lodel/scripts/nusoap.php [line 1636]

nusoap_base
   |
   --soap_transport_http

Author(s):

Dietrich Ayala <dietrich@ganx4.com>

API Tags:

Access:

public

Information Tags:

Version:

$Id: nusoap.php 3705 2006-09-14 16:06:29Z cenou $

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From nusoap_base

nusoap_base::$charencoding

nusoap_base::$debug_str

nusoap_base::$error_str

nusoap_base::$namespaces

nusoap_base::$revision

nusoap_base::$soap_defencoding

nusoap_base::$title

nusoap_base::$typemap

nusoap_base::$usedNamespaces

nusoap_base::$version

nusoap_base::$xmlEntities

nusoap_base::$XMLSchemaVersion

Inherited From nusoap_base

nusoap_base::appendDebug()

adds debug data to the instance debug string without formatting

nusoap_base::clearDebug()

clears the current debug data for this instance

nusoap_base::contractQname()

contracts a qualified name

nusoap_base::debug()

adds debug data to the instance debug string with formatting

nusoap_base::expandEntities()

expands entities, e.g. changes '<' to '<'.

nusoap_base::expandQname()

expands a qualified name

nusoap_base::formatDump()

nusoap_base::getDebug()

gets the current debug data for this instance

nusoap_base::getDebugAsXMLComment()

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

nusoap_base::getError()

returns error string if present

nusoap_base::getLocalPart()

returns the local part of a prefixed string returns the original string, if not prefixed

nusoap_base::getmicrotime()

returns the time in ODBC canonical form with microseconds

nusoap_base::getNamespaceFromPrefix()

pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix

nusoap_base::getPrefix()

returns the prefix part of a prefixed string returns false, if not prefixed

nusoap_base::getPrefixFromNamespace()

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

nusoap_base::isArraySimpleOrStruct()

detect if array is a simple array or a struct (associative array)

nusoap_base::serializeEnvelope()

serialize message

nusoap_base::serialize_val()

serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.

nusoap_base::setError()

sets error string

nusoap_base::varDump()

[ Top ]

Property Summary

mixed	$ch
mixed	$digest_uri
mixed	$encoding
mixed	$host
mixed	$incoming_headers
mixed	$incoming_payload
mixed	$outgoing_headers
mixed	$outgoing_payload
mixed	$password
mixed	$path
mixed	$persistentConnection
mixed	$port
mixed	$protocol_version
mixed	$request_method
mixed	$scheme
mixed	$uri
mixed	$url
mixed	$username
mixed	$useSOAPAction

[ Top ]

Method Summary

soap_transport_http	soap_transport_http()	constructor
void	buildPayload()
void	connect()
string	decodeChunked()	decode a string that is encoded w/ "chunked' transfer encoding as defined in RFC2068 19.4.6
void	getResponse()
string	send()	send the SOAP message via HTTP
string	sendHTTPS()	send the SOAP message via HTTPS 1.0 using CURL
void	sendRequest()
void	setContentType()
void	setCredentials()	if authenticating, set user credentials here
void	setEncoding()	use http encoding
void	setProxy()	set proxy info here
void	setSOAPAction()	set the soapaction value
void	setURL()
void	usePersistentConnection()

[ Top ]

Properties

mixed $ch = false [line 1654]

[ Top ]

mixed $digest_uri = '' [line 1640]

[ Top ]

mixed $encoding = '' [line 1647]

[ Top ]

mixed $host = '' [line 1642]

[ Top ]

mixed $incoming_headers = array() [line 1649]

[ Top ]

mixed $incoming_payload = '' [line 1651]

[ Top ]

mixed $outgoing_headers = array() [line 1648]

[ Top ]

mixed $outgoing_payload = '' [line 1650]

[ Top ]

mixed $password [line 1656]

[ Top ]

mixed $path = '' [line 1644]

[ Top ]

mixed $persistentConnection = false [line 1653]

[ Top ]

mixed $port = '' [line 1643]

[ Top ]

mixed $protocol_version = '1.0' [line 1646]

[ Top ]

mixed $request_method = 'POST' [line 1645]

[ Top ]

mixed $scheme = '' [line 1641]

[ Top ]

mixed $uri = '' [line 1639]

[ Top ]

mixed $url = '' [line 1638]

[ Top ]

mixed $username [line 1655]

[ Top ]

mixed $useSOAPAction = true [line 1652]

[ Top ]

Methods

Constructor soap_transport_http [line 1661]

soap_transport_http soap_transport_http(

$url 
)

constructor

Parameters:

$url:

[ Top ]

buildPayload [line 2054]

void buildPayload(

$data 
)

Parameters:

$data:

[ Top ]

connect [line 1705]

void connect(
[
$connection_timeout = 0], [
$response_timeout = 30] 
)

Parameters:

	$connection_timeout:
	$response_timeout:

[ Top ]

decodeChunked [line 2002]

string decodeChunked(
string
$buffer, string
$lb 
)

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

Parameters:

string	$buffer:
string	$lb:

API Tags:

Deprecated:
Access:	public

[ Top ]

getResponse [line 2112]

void getResponse(
)

[ Top ]

send [line 1832]

string send(
string
$data, [integer
$timeout = 0], [integer
$response_timeout = 30] 
)

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

API Tags:

Return:	data
Access:	public

[ Top ]

sendHTTPS [line 1871]

string sendHTTPS(

$data, [integer
$timeout = 0], [integer
$response_timeout = 30], string
$msg 
)

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
	$data:

API Tags:

Return:	data
Access:	public

[ Top ]

sendRequest [line 2079]

void sendRequest(

$data 
)

Parameters:

$data:

[ Top ]

setContentType [line 2443]

void setContentType(

$type, [
$charset = false] 
)

Parameters:

	$type:
	$charset:

[ Top ]

setCredentials [line 1884]

void setCredentials(
string
$username, string
$password, [string
$authtype = 'basic'], [array
$digestRequest = array()] 
)

if authenticating, set user credentials here

Parameters:

string	$username:
string	$password:
string	$authtype:
array	$digestRequest:

API Tags:

Access:

public

[ Top ]

setEncoding [line 1962]

void setEncoding(
[string
$enc = 'gzip, deflate'] 
)

use http encoding

Parameters:

string

$enc:

encoding style. supported values: gzip, deflate, or both

API Tags:

Access:

public

[ Top ]

setProxy [line 1983]

void setProxy(
string
$proxyhost, string
$proxyport, [string
$proxyusername = ''], [string
$proxypassword = ''] 
)

set proxy info here

Parameters:

string	$proxyhost:
string	$proxyport:
string	$proxyusername:
string	$proxypassword:

API Tags:

Access:

public

[ Top ]

setSOAPAction [line 1952]

void setSOAPAction(
string
$soapaction 
)

set the soapaction value

Parameters:

string

$soapaction:

API Tags:

Access:

public

[ Top ]

setURL [line 1667]

void setURL(

$url 
)

Parameters:

$url:

[ Top ]

usePersistentConnection [line 2447]

void usePersistentConnection(
)

[ Top ]

Documentation generated on Wed, 19 Sep 2007 05:07:19 +0200 by phpDocumentor 1.4.0a2

	default

[ class tree: default ] [ index: default ] [ all elements ]