\soap_transport_http
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>
Synopsis
class soap_transport_http
extends nusoap_base
{
- // members
- public string $url = '';
- public string $uri = '';
- public string $digest_uri = '';
- public string $scheme = '';
- public string $host = '';
- public string $port = '';
- public string $path = '';
- public string $request_method = 'POST';
- public string $protocol_version = '1.0';
- public string $encoding = '';
- public array $outgoing_headers = ;
- public array $incoming_headers = ;
- public array $incoming_cookies = ;
- public string $outgoing_payload = '';
- public string $incoming_payload = '';
- public $response_status_line;
- public boolean $useSOAPAction = true;
- public boolean $persistentConnection = false;
- public boolean $ch = false;
- public array $ch_options = ;
- public boolean $use_curl = false;
- public $proxy = NULL;
- public string $username = '';
- public string $password = '';
- public string $authtype = '';
- public array $digestRequest = ;
- public array $certRequest = ;
- // Inherited members from nusoap_base
- public string $title;
- public string $version;
- public string $revision;
- public string $error_str;
- public string $debug_str;
- public boolean $charencoding;
- public $debugLevel;
- public string $XMLSchemaVersion;
- public string $soap_defencoding;
- public array $namespaces;
- public array $usedNamespaces;
- public array $typemap;
- public array $xmlEntities;
- // methods
- public void soap_transport_http()
- public void setCurlOption()
- public void setHeader()
- public void unsetHeader()
- public void setURL()
- public string io_method()
- public boolean connect()
- public string send()
- public string sendHTTPS()
- public void setCredentials()
- public void setSOAPAction()
- public void setEncoding()
- public void setProxy()
- public void isSkippableCurlHeader()
- public void decodeChunked()
- public void buildPayload()
- public boolean sendRequest()
- public string getResponse()
- public void setContentType()
- public boolean usePersistentConnection()
- public void parseCookie()
- public string getCookiesForRequest()
- // Inherited methods from nusoap_base
- public void nusoap_base()
- public integer getGlobalDebugLevel()
- public void setGlobalDebugLevel()
- public int getDebugLevel()
- public void setDebugLevel()
- public void debug()
- public void appendDebug()
- public void clearDebug()
- public debug getDebug()
- public debug getDebugAsXMLComment()
- public void expandEntities()
- public mixed getError()
- public boolean setError()
- public string isArraySimpleOrStruct()
- public string serialize_val()
- public string serializeEnvelope()
- public string formatDump()
- public string contractQname()
- public string expandQname()
- public string getLocalPart()
- public mixed getPrefix()
- public mixed getNamespaceFromPrefix()
- public mixed getPrefixFromNamespace()
- public string getmicrotime()
- public string varDump()
- public string __toString()
Hierarchy
Extends
Tasks
Line | Task |
---|---|
2350 | disabled for now because OpenSSL must be *compiled* in (not just |
692 | add an option to automatically run utf8_encode on $body and $headers |
Members
public
- $XMLSchemaVersion
—
string
set schema version - $authtype
- $certRequest
- $ch
- $ch_options
- $charencoding
—
boolean
toggles automatic encoding of special characters as entities (should always be true, I think) - $debugLevel
—
integer
the debug level for this instance - $debug_str
—
string
Current debug string (manipulated by debug/appendDebug/clearDebug/getDebug/getDebugAsXMLComment) - $digestRequest
- $digest_uri
- $encoding
- $error_str
—
string
Current error string (manipulated by getError/setError) - $host
- $incoming_headers
- $incoming_payload
- $namespaces
—
array
namespaces in an array of prefix => uri - $outgoing_headers
- $outgoing_payload
- $password
- $path
- $persistentConnection
- $port
- $protocol_version
- $proxy
- $request_method
- $response_status_line
- $revision
—
string
CVS revision for HTTP headers. - $scheme
- $soap_defencoding
—
string
charset encoding for outgoing messages - $title
—
string
Identification for HTTP headers. - $typemap
—
array
XML Schema types in an array of uri => (array of xml type => php type) is this legacy yet? no, this is used by the nusoap_xmlschema class to verify type => namespace mappings. - $uri
- $url
- $useSOAPAction
- $use_curl
- $usedNamespaces
—
array
namespaces used in the current context, e.g. during serialization - $username
- $version
—
string
Version for HTTP headers. - $xmlEntities
—
array
XML entities to convert
Methods
public
- buildPayload() — Writes the payload, including HTTP headers, to $this->outgoing_payload.
- connect() — establish an HTTP connection
- decodeChunked() — decode a string that is encoded w/ "chunked' transfer encoding as defined in RFC2068 19.4.6
- getCookiesForRequest() — sort out cookies for the current request
- getResponse() — gets the SOAP response via HTTP[S]
- io_method() — gets the I/O method to use
- isSkippableCurlHeader() — Test if the given string starts with a header that is to be skipped.
- parseCookie()
- send() — sends the SOAP request and gets the SOAP response via HTTP[S]
- sendHTTPS() — sends the SOAP request and gets the SOAP response via HTTPS using CURL
- sendRequest() — sends the SOAP request via HTTP[S]
- setContentType() — sets the content-type for the SOAP message to be sent
- setCredentials() — if authenticating, set user credentials here
- setCurlOption() — sets a cURL option
- setEncoding() — use http encoding
- setHeader() — sets an HTTP header
- setProxy() — set proxy info here
- setSOAPAction() — set the soapaction value
- setURL() — sets the URL to which to connect
- soap_transport_http() — constructor
- unsetHeader() — unsets an HTTP header
- usePersistentConnection() — specifies that an HTTP persistent connection should be used
Inherited from nusoap_base
public
- __toString() — represents the object as a string
- appendDebug() — adds debug data to the instance debug string without formatting
- clearDebug() — clears the current debug data for this instance
- contractQname() — contracts (changes namespace to prefix) a qualified name
- debug() — adds debug data to the instance debug string with formatting
- expandEntities() — expands entities, e.g. changes '<' to '<'.
- expandQname() — expands (changes prefix to namespace) a qualified name
- formatDump() — formats a string to be inserted into an HTML stream
- getDebug() — gets the current debug data for this instance
- getDebugAsXMLComment() — gets the current debug data for this instance as an XML comment this may change the contents of the debug data
- getDebugLevel() — gets the debug level for this instance
- getError() — returns error string if present
- getGlobalDebugLevel() — gets the global debug level, which applies to future instances
- getLocalPart() — returns the local part of a prefixed string returns the original string, if not prefixed
- getNamespaceFromPrefix() — pass it a prefix, it returns a namespace
- getPrefix() — returns the prefix part of a prefixed string returns false, if not prefixed
- getPrefixFromNamespace() — returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace
- getmicrotime() — returns the time in ODBC canonical form with microseconds
- isArraySimpleOrStruct() — detect if array is a simple array or a struct (associative array)
- nusoap_base() — constructor
- serializeEnvelope() — serializes a message
- serialize_val() — serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.
- setDebugLevel() — sets the debug level for this instance
- setError() — sets error string
- setGlobalDebugLevel() — sets the global debug level, which applies to future instances
- varDump() — Returns a string with the output of var_dump