ILIAS
Release_5_0_x_branch Revision 61816
|
soapclient higher level class for easy usage. More...
Public Member Functions | |
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 | |
parseResponse ($headers, $data) | |
processes SOAP message returned from server | |
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 | |
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. | |
decodeUTF8 ($bool) | |
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', $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 |
Data Fields | |
$username = '' | |
$password = '' | |
$authtype = '' | |
$requestHeaders = false | |
$responseHeaders = '' | |
$document = '' | |
$endpoint | |
$error_str = false | |
$proxyhost = '' | |
$proxyport = '' | |
$proxyusername = '' | |
$proxypassword = '' | |
$xml_encoding = '' | |
$http_encoding = false | |
$timeout = 0 | |
$response_timeout = 30 | |
$endpointType = '' | |
$persistentConnection = false | |
$defaultRpcParams = false | |
$request = '' | |
$response = '' | |
$responseData = '' | |
$decode_utf8 = true | |
$fault | |
$faultcode | |
$faultstring | |
$faultdetail | |
Data Fields inherited from nusoap_base | |
$title = 'NuSOAP' | |
$version = '0.6.7' | |
$revision = '$Revision: 11808 $' | |
$error_str = false | |
$debug_str = '' | |
$charencoding = true | |
$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema' | |
$soap_defencoding = 'UTF-8' | |
$namespaces | |
$usedNamespaces = array() | |
$typemap | |
$xmlEntities | |
$debugLevel |
soapclient higher level class for easy usage.
usage:
// instantiate client with server info $soapclient = new soapclient( string path [ ,boolean wsdl] );
// call method, get results echo $soapclient->call( string methodname [ ,array parameters] );
// bye bye client unset($soapclient);
Definition at line 4968 of file nusoap.php.
soap_client::call | ( | $operation, | |
$params = array() , |
|||
$namespace = '' , |
|||
$soapAction = '' , |
|||
$headers = false , |
|||
$rpcParams = null , |
|||
$style = 'rpc' , |
|||
$use = 'encoded' |
|||
) |
calls method, returns PHP native type
string | $method | SOAP server URL or path |
array | $params | An array, associative or simple, of the parameters for the method call, or a string that is the XML for the call. For rpc style, this call will wrap the XML in a tag named after the method, as well as the SOAP Envelope and Body. For document style, this will only wrap with the Envelope and Body. IMPORTANT: when using an array with document style, in which case there is really one parameter, the root of the fragment used in the call, which encloses what programmers normally think of parameters. A parameter array must include the wrapper. |
string | $namespace | optional method namespace (WSDL can override) |
string | $soapAction | optional SOAPAction value (WSDL can override) |
boolean | $headers | optional array of soapval objects for headers |
boolean | $rpcParams | optional no longer used |
string | $style | optional (rpc|document) the style to use when serializing parameters (WSDL can override) |
string | $use | optional (encoded|literal) the use when serializing parameters (WSDL can override) |
Definition at line 5084 of file nusoap.php.
References $namespace, nusoap_base\$usedNamespaces, nusoap_base\debug(), nusoap_base\getError(), getHTTPBody(), getOperationData(), nusoap_base\getPrefixFromNamespace(), send(), nusoap_base\serialize_val(), nusoap_base\serializeEnvelope(), wsdl\serializeRPCParameters(), and nusoap_base\setError().
soap_client::decodeUTF8 | ( | $bool | ) |
Definition at line 5577 of file nusoap.php.
soap_client::getDefaultRpcParams | ( | ) |
gets the default RPC parameter setting.
If true, default is that call params are like RPC even for document style. Each call() can override this value.
This is no longer used.
public
Definition at line 5463 of file nusoap.php.
References $defaultRpcParams.
soap_client::getHeaders | ( | ) |
get the response headers
Definition at line 5398 of file nusoap.php.
References $responseHeaders.
soap_client::getHTTPBody | ( | $soapmsg | ) |
gets the HTTP body for the current request.
string | $soapmsg | The SOAP payload |
Definition at line 5542 of file nusoap.php.
Referenced by call().
soap_client::getHTTPContentType | ( | ) |
gets the HTTP content type for the current request.
Note: getHTTPBody must be called before this.
Definition at line 5554 of file nusoap.php.
Referenced by send().
soap_client::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.
Definition at line 5567 of file nusoap.php.
References nusoap_base\$soap_defencoding.
Referenced by send().
soap_client::getOperationData | ( | $operation | ) |
get available data pertaining to an operation
string | $operation | operation name |
Definition at line 5237 of file nusoap.php.
References nusoap_base\debug().
Referenced by call().
soap_client::getProxy | ( | ) |
dynamically creates proxy class, allowing user to directly call methods from wsdl
Definition at line 5485 of file nusoap.php.
References $defaultRpcParams, $http_encoding, $password, $persistentConnection, $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, and $username.
soap_client::parseResponse | ( | $headers, | |
$data | |||
) |
processes SOAP message returned from server
array | $headers | The HTTP headers |
string | $data | unprocessed response data from server |
Definition at line 5339 of file nusoap.php.
References nusoap_base\debug(), and nusoap_base\setError().
Referenced by send().
soap_client::send | ( | $msg, | |
$soapaction = '' , |
|||
$timeout = 0 , |
|||
$response_timeout = 30 |
|||
) |
send the SOAP message
Note: if the operation has multiple return values the return value of this method will be an array of those values.
@param string $msg a SOAPx4 soapmsg object @param string $soapaction SOAPAction value @param integer $timeout set connection timeout in seconds @param integer $response_timeout set response timeout in seconds @return mixed native PHP types. @access private
Definition at line 5258 of file nusoap.php.
References $persistentConnection, $response_timeout, $timeout, nusoap_base\debug(), nusoap_base\getError(), getHTTPContentType(), getHTTPContentTypeCharset(), parseResponse(), and nusoap_base\setError().
Referenced by call().
soap_client::setCredentials | ( | $username, | |
$password, | |||
$authtype = 'basic' |
|||
) |
if authenticating, set user credentials here
string | $username | |
string | $password | |
string | $authtype | (basic|digest) public |
Definition at line 5428 of file nusoap.php.
soap_client::setDefaultRpcParams | ( | $rpcParams | ) |
sets the default RPC parameter setting.
If true, default is that call params are like RPC even for document style Each call() can override this value.
boolean | $rpcParams | public |
Definition at line 5475 of file nusoap.php.
soap_client::setHeaders | ( | $headers | ) |
set the SOAP headers
$headers | string XML public |
Definition at line 5388 of file nusoap.php.
soap_client::setHTTPEncoding | ( | $enc = 'gzip , |
|
deflate' | |||
) |
use HTTP encoding
string | $enc | public |
Definition at line 5440 of file nusoap.php.
soap_client::setHTTPProxy | ( | $proxyhost, | |
$proxyport, | |||
$proxyusername = '' , |
|||
$proxypassword = '' |
|||
) |
set proxy info here
string | $proxyhost | |
string | $proxyport | |
string | $proxyusername | |
string | $proxypassword | public |
Definition at line 5413 of file nusoap.php.
References $proxyhost, $proxypassword, $proxyport, and $proxyusername.
soap_client::soap_client | ( | $endpoint, | |
$wsdl = false , |
|||
$proxyhost = false , |
|||
$proxyport = false , |
|||
$proxyusername = false , |
|||
$proxypassword = false , |
|||
$timeout = 0 , |
|||
$response_timeout = 30 |
|||
) |
constructor
mixed | $endpoint | SOAP server or WSDL URL (string), or wsdl instance (object) |
bool | $wsdl | optional, set to true if using WSDL |
int | $portName | optional portName in WSDL document |
string | $proxyhost | |
string | $proxyport | |
string | $proxyusername | |
string | $proxypassword | |
integer | $timeout | set the connection timeout |
integer | $response_timeout | set the response timeout public |
Definition at line 5020 of file nusoap.php.
References $endpoint, $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, nusoap_base\debug(), nusoap_base\getError(), wsdl\getOperations(), nusoap_base\setError(), and wsdl\wsdl().
soap_client::useHTTPPersistentConnection | ( | ) |
use HTTP persistent connections if possible
public
Definition at line 5449 of file nusoap.php.
soap_client::$authtype = '' |
Definition at line 4972 of file nusoap.php.
Referenced by setCredentials().
soap_client::$decode_utf8 = true |
Definition at line 4993 of file nusoap.php.
soap_client::$defaultRpcParams = false |
Definition at line 4988 of file nusoap.php.
Referenced by getDefaultRpcParams(), and getProxy().
soap_client::$document = '' |
Definition at line 4975 of file nusoap.php.
soap_client::$endpoint |
Definition at line 4976 of file nusoap.php.
Referenced by soap_client().
soap_client::$endpointType = '' |
Definition at line 4986 of file nusoap.php.
soap_client::$error_str = false |
Definition at line 4977 of file nusoap.php.
soap_client::$fault |
Definition at line 5004 of file nusoap.php.
soap_client::$faultcode |
Definition at line 5004 of file nusoap.php.
soap_client::$faultdetail |
Definition at line 5004 of file nusoap.php.
soap_client::$faultstring |
Definition at line 5004 of file nusoap.php.
soap_client::$http_encoding = false |
Definition at line 4983 of file nusoap.php.
Referenced by getProxy().
soap_client::$password = '' |
Definition at line 4971 of file nusoap.php.
Referenced by getProxy(), and setCredentials().
soap_client::$persistentConnection = false |
Definition at line 4987 of file nusoap.php.
Referenced by getProxy(), and send().
soap_client::$proxyhost = '' |
Definition at line 4978 of file nusoap.php.
Referenced by getProxy(), setHTTPProxy(), and soap_client().
soap_client::$proxypassword = '' |
Definition at line 4981 of file nusoap.php.
Referenced by getProxy(), setHTTPProxy(), and soap_client().
soap_client::$proxyport = '' |
Definition at line 4979 of file nusoap.php.
Referenced by getProxy(), setHTTPProxy(), and soap_client().
soap_client::$proxyusername = '' |
Definition at line 4980 of file nusoap.php.
Referenced by getProxy(), setHTTPProxy(), and soap_client().
soap_client::$request = '' |
Definition at line 4989 of file nusoap.php.
soap_client::$requestHeaders = false |
Definition at line 4973 of file nusoap.php.
soap_client::$response = '' |
Definition at line 4990 of file nusoap.php.
soap_client::$response_timeout = 30 |
Definition at line 4985 of file nusoap.php.
Referenced by getProxy(), send(), and soap_client().
soap_client::$responseData = '' |
Definition at line 4991 of file nusoap.php.
soap_client::$responseHeaders = '' |
Definition at line 4974 of file nusoap.php.
Referenced by getHeaders().
soap_client::$timeout = 0 |
Definition at line 4984 of file nusoap.php.
Referenced by getProxy(), send(), and soap_client().
soap_client::$username = '' |
Definition at line 4970 of file nusoap.php.
Referenced by getProxy(), and setCredentials().
soap_client::$xml_encoding = '' |
Definition at line 4982 of file nusoap.php.