ILIAS
Release_4_0_x_branch Revision 61816
|
soap_clientmime client supporting MIME attachments defined at http://www.w3.org/TR/SOAP-attachments. More...
Public Member Functions | |
addAttachment ($data, $filename= '', $contenttype= 'application/octet-stream', $cid=false) | |
adds a MIME attachment to the current request. | |
clearAttachments () | |
clears the MIME attachments for the current request. | |
getAttachments () | |
gets the MIME attachments from the current response. | |
getHTTPBody ($soapmsg) | |
gets the HTTP body for the current request. | |
getHTTPContentType () | |
gets the HTTP content type for the current request. | |
getHTTPContentTypeCharset () | |
gets the HTTP content type charset for the current request. | |
parseResponse ($headers, $data) | |
processes SOAP message returned from server | |
Public Member Functions inherited from soap_client | |
soap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
call ($operation, $params=array(), $namespace='', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded') | |
calls method, returns PHP native type | |
getOperationData ($operation) | |
get available data pertaining to an operation | |
send ($msg, $soapaction= '', $timeout=0, $response_timeout=30) | |
send the SOAP message | |
setHeaders ($headers) | |
set the SOAP headers | |
getHeaders () | |
get the response headers | |
setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '') | |
set proxy info here | |
setCredentials ($username, $password, $authtype= 'basic') | |
if authenticating, set user credentials here | |
setHTTPEncoding ($enc='gzip, deflate') | |
use HTTP encoding | |
useHTTPPersistentConnection () | |
use HTTP persistent connections if possible | |
getDefaultRpcParams () | |
gets the default RPC parameter setting. | |
setDefaultRpcParams ($rpcParams) | |
sets the default RPC parameter setting. | |
getProxy () | |
dynamically creates proxy class, allowing user to directly call methods from wsdl | |
decodeUTF8 ($bool) | |
soap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
call ($operation, $params=array(), $namespace='http://tempuri.org', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded') | |
calls method, returns PHP native type | |
getOperationData ($operation) | |
get available data pertaining to an operation | |
send ($msg, $soapaction= '', $timeout=0, $response_timeout=30) | |
send the SOAP message | |
setEndpoint ($endpoint) | |
sets the SOAP endpoint, which can override WSDL | |
setHeaders ($headers) | |
set the SOAP headers | |
getHeaders () | |
get the SOAP response headers (namespace resolution incomplete) | |
setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '') | |
set proxy info here | |
setCredentials ($username, $password, $authtype= 'basic', $certRequest=array()) | |
if authenticating, set user credentials here | |
setHTTPEncoding ($enc='gzip, deflate') | |
use HTTP encoding | |
useHTTPPersistentConnection () | |
use HTTP persistent connections if possible | |
getDefaultRpcParams () | |
gets the default RPC parameter setting. | |
setDefaultRpcParams ($rpcParams) | |
sets the default RPC parameter setting. | |
getProxy () | |
dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl | |
_getProxyClassCode ($r) | |
dynamically creates proxy class code | |
getProxyClassCode () | |
dynamically creates proxy class code | |
decodeUTF8 ($bool) | |
setCookie ($name, $value) | |
adds a new Cookie into $this->cookies array | |
getCookies () | |
gets all Cookies | |
checkCookies () | |
checks all Cookies and delete those which are expired | |
UpdateCookies ($cookies) | |
updates the current cookies with a new set | |
soap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
call ($operation, $params=array(), $namespace='', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded') | |
calls method, returns PHP native type | |
getOperationData ($operation) | |
get available data pertaining to an operation | |
send ($msg, $soapaction= '', $timeout=0, $response_timeout=30) | |
send the SOAP message | |
setHeaders ($headers) | |
set the SOAP headers | |
getHeaders () | |
get the response headers | |
setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '') | |
set proxy info here | |
setCredentials ($username, $password, $authtype= 'basic') | |
if authenticating, set user credentials here | |
setHTTPEncoding ($enc='gzip, deflate') | |
use HTTP encoding | |
useHTTPPersistentConnection () | |
use HTTP persistent connections if possible | |
getDefaultRpcParams () | |
gets the default RPC parameter setting. | |
setDefaultRpcParams ($rpcParams) | |
sets the default RPC parameter setting. | |
getProxy () | |
dynamically creates proxy class, allowing user to directly call methods from wsdl | |
decodeUTF8 ($bool) | |
soap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
call ($operation, $params=array(), $namespace='http://tempuri.org', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded') | |
calls method, returns PHP native type | |
getOperationData ($operation) | |
get available data pertaining to an operation | |
send ($msg, $soapaction= '', $timeout=0, $response_timeout=30) | |
send the SOAP message | |
setEndpoint ($endpoint) | |
sets the SOAP endpoint, which can override WSDL | |
setHeaders ($headers) | |
set the SOAP headers | |
getHeaders () | |
get the SOAP response headers (namespace resolution incomplete) | |
setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '') | |
set proxy info here | |
setCredentials ($username, $password, $authtype= 'basic', $certRequest=array()) | |
if authenticating, set user credentials here | |
setHTTPEncoding ($enc='gzip, deflate') | |
use HTTP encoding | |
useHTTPPersistentConnection () | |
use HTTP persistent connections if possible | |
getDefaultRpcParams () | |
gets the default RPC parameter setting. | |
setDefaultRpcParams ($rpcParams) | |
sets the default RPC parameter setting. | |
getProxy () | |
dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl | |
_getProxyClassCode ($r) | |
dynamically creates proxy class code | |
getProxyClassCode () | |
dynamically creates proxy class code | |
decodeUTF8 ($bool) | |
setCookie ($name, $value) | |
adds a new Cookie into $this->cookies array | |
getCookies () | |
gets all Cookies | |
checkCookies () | |
checks all Cookies and delete those which are expired | |
UpdateCookies ($cookies) | |
updates the current cookies with a new set | |
Public Member Functions inherited from nusoap_client | |
nusoap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
checkWSDL () | |
check WSDL passed as an instance or pulled from an endpoint | |
loadWSDL () | |
instantiate wsdl object and parse wsdl file | |
setCurlOption ($option, $value) | |
sets user-specified cURL options | |
getHeader () | |
get the SOAP response Header (parsed) | |
setUseCURL ($use) | |
Set whether to try to use cURL connections if possible. | |
nusoap_client ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30) | |
constructor | |
checkWSDL () | |
check WSDL passed as an instance or pulled from an endpoint | |
loadWSDL () | |
instantiate wsdl object and parse wsdl file | |
setCurlOption ($option, $value) | |
sets user-specified cURL options | |
getHeader () | |
get the SOAP response Header (parsed) | |
setUseCURL ($use) | |
Set whether to try to use cURL connections if possible. | |
Public Member Functions inherited from nusoap_base | |
debug ($string) | |
adds debug data to the class level debug string | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded') | |
serializes PHP values in accordance w/ section 5. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded') | |
serialize message | |
formatDump ($str) | |
contractQname ($qname) | |
contracts a qualified name | |
expandQname ($qname) | |
expands a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix | |
getPrefixFromNamespace ($ns) | |
returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace | |
varDump ($data) | |
nusoap_base () | |
constructor | |
getGlobalDebugLevel () | |
gets the global debug level, which applies to future instances | |
setGlobalDebugLevel ($level) | |
sets the global debug level, which applies to future instances | |
getDebugLevel () | |
gets the debug level for this instance | |
setDebugLevel ($level) | |
sets the debug level for this instance | |
debug ($string) | |
adds debug data to the instance debug string with formatting | |
appendDebug ($string) | |
adds debug data to the instance debug string without formatting | |
clearDebug () | |
clears the current debug data for this instance | |
& | 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 | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded') | |
serializes PHP values in accordance w/ section 5. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/') | |
serializes a message | |
formatDump ($str) | |
formats a string to be inserted into an HTML stream | |
contractQname ($qname) | |
contracts (changes namespace to prefix) a qualified name | |
expandQname ($qname) | |
expands (changes prefix to namespace) a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace | |
getPrefixFromNamespace ($ns) | |
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 | |
varDump ($data) | |
Returns a string with the output of var_dump. | |
nusoap_base () | |
constructor | |
getGlobalDebugLevel () | |
gets the global debug level, which applies to future instances | |
setGlobalDebugLevel ($level) | |
sets the global debug level, which applies to future instances | |
getDebugLevel () | |
gets the debug level for this instance | |
setDebugLevel ($level) | |
sets the debug level for this instance | |
debug ($string) | |
adds debug data to the instance debug string with formatting | |
appendDebug ($string) | |
adds debug data to the instance debug string without formatting | |
clearDebug () | |
clears the current debug data for this instance | |
& | 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 | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded') | |
serializes PHP values in accordance w/ section 5. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/') | |
serializes a message | |
formatDump ($str) | |
formats a string to be inserted into an HTML stream | |
contractQname ($qname) | |
contracts (changes namespace to prefix) a qualified name | |
expandQname ($qname) | |
expands (changes prefix to namespace) a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace | |
getPrefixFromNamespace ($ns) | |
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 | |
varDump ($data) | |
Returns a string with the output of var_dump. | |
nusoap_base () | |
constructor | |
getGlobalDebugLevel () | |
gets the global debug level, which applies to future instances | |
setGlobalDebugLevel ($level) | |
sets the global debug level, which applies to future instances | |
getDebugLevel () | |
gets the debug level for this instance | |
setDebugLevel ($level) | |
sets the debug level for this instance | |
debug ($string) | |
adds debug data to the instance debug string with formatting | |
appendDebug ($string) | |
adds debug data to the instance debug string without formatting | |
clearDebug () | |
clears the current debug data for this instance | |
& | 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 | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false) | |
serializes PHP values in accordance w/ section 5. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/') | |
serializes a message | |
formatDump ($str) | |
formats a string to be inserted into an HTML stream | |
contractQname ($qname) | |
contracts (changes namespace to prefix) a qualified name | |
expandQname ($qname) | |
expands (changes prefix to namespace) a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace | |
getPrefixFromNamespace ($ns) | |
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 | |
varDump ($data) | |
Returns a string with the output of var_dump. | |
__toString () | |
represents the object as a string | |
nusoap_base () | |
constructor | |
getGlobalDebugLevel () | |
gets the global debug level, which applies to future instances | |
setGlobalDebugLevel ($level) | |
sets the global debug level, which applies to future instances | |
getDebugLevel () | |
gets the debug level for this instance | |
setDebugLevel ($level) | |
sets the debug level for this instance | |
debug ($string) | |
adds debug data to the instance debug string with formatting | |
appendDebug ($string) | |
adds debug data to the instance debug string without formatting | |
clearDebug () | |
clears the current debug data for this instance | |
& | 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 | |
expandEntities ($val) | |
expands entities, e.g. | |
getError () | |
returns error string if present | |
setError ($str) | |
sets error string | |
isArraySimpleOrStruct ($val) | |
detect if array is a simple array or a struct (associative array) | |
serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false) | |
serializes PHP values in accordance w/ section 5. | |
serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/') | |
serializes a message | |
formatDump ($str) | |
formats a string to be inserted into an HTML stream | |
contractQname ($qname) | |
contracts (changes namespace to prefix) a qualified name | |
expandQname ($qname) | |
expands (changes prefix to namespace) a qualified name | |
getLocalPart ($str) | |
returns the local part of a prefixed string returns the original string, if not prefixed | |
getPrefix ($str) | |
returns the prefix part of a prefixed string returns false, if not prefixed | |
getNamespaceFromPrefix ($prefix) | |
pass it a prefix, it returns a namespace | |
getPrefixFromNamespace ($ns) | |
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 | |
varDump ($data) | |
Returns a string with the output of var_dump. | |
__toString () | |
represents the object as a string |
soap_clientmime client supporting MIME attachments defined at http://www.w3.org/TR/SOAP-attachments.
It depends on the PEAR Mail_MIME library.
public
Definition at line 48 of file nusoapmime.php.
soap_clientmime::addAttachment | ( | $data, | |
$filename = '' , |
|||
$contenttype = 'application/octet-stream' , |
|||
$cid = false |
|||
) |
adds a MIME attachment to the current request.
If the $data parameter contains an empty string, this method will read the contents of the file named by the $filename parameter.
If the $cid parameter is false, this method will generate the cid.
string | $data | The data of the attachment |
string | $filename | The filename of the attachment (default is empty string) |
string | $contenttype | The MIME Content-Type of the attachment (default is application/octet-stream) |
string | $cid | The content-id (cid) of the attachment (default is false) |
Definition at line 82 of file nusoapmime.php.
soap_clientmime::clearAttachments | ( | ) |
clears the MIME attachments for the current request.
public
Definition at line 102 of file nusoapmime.php.
soap_clientmime::getAttachments | ( | ) |
gets the MIME attachments from the current response.
Each array element in the return is an associative array with keys data, filename, contenttype, cid. These keys correspond to the parameters for addAttachment.
Definition at line 116 of file nusoapmime.php.
References $responseAttachments.
soap_clientmime::getHTTPBody | ( | $soapmsg | ) |
gets the HTTP body for the current request.
string | $soapmsg | The SOAP payload |
Reimplemented from soap_client.
Definition at line 127 of file nusoapmime.php.
References $data, $params, nusoap_base\$soap_defencoding, and nusoap_base\debug().
soap_clientmime::getHTTPContentType | ( | ) |
gets the HTTP content type for the current request.
Note: getHTTPBody must be called before this.
Reimplemented from soap_client.
Definition at line 186 of file nusoapmime.php.
References $mimeContentType.
soap_clientmime::getHTTPContentTypeCharset | ( | ) |
gets the HTTP content type charset for the current request.
returns false for non-text content types.
Note: getHTTPBody must be called before this.
Reimplemented from soap_client.
Definition at line 202 of file nusoapmime.php.
soap_clientmime::parseResponse | ( | $headers, | |
$data | |||
) |
processes SOAP message returned from server
array | $headers | The HTTP headers |
string | $data | unprocessed response data from server |
Reimplemented from soap_client.
Definition at line 217 of file nusoapmime.php.
References $data, $params, nusoap_base\debug(), and nusoap_base\setError().
soap_clientmime::$mimeContentType |
Definition at line 65 of file nusoapmime.php.
Referenced by getHTTPContentType().
soap_clientmime::$requestAttachments = array() |
Definition at line 54 of file nusoapmime.php.
soap_clientmime::$responseAttachments |
Definition at line 60 of file nusoapmime.php.
Referenced by getAttachments().