|
|
soapclient
nusoap_base | +-- soapclient
|
public class soapclient extends nusoap_base
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);
|
|
|
Methods inherited from nusoap_base |
nusoap_base, debug, geterror, seterror, serialize_val, serializeenvelope, soapval, serialize, decode, soap_parser, start_element, end_element, character_data, get_response, decode_entities, buildval, buildsoapval, soap_transport_http, setsoapaction, setproxy, sendhttps, soap_server, service, parse_request, verify_method, add_to_map, register, fault, webdescription, configurewsdl, xmlschema, parsefile, parsestring, schemastartelement, schemaendelement, schemacharacterdata, serializeschema, expandqname, xdebug, getphptype, getlocalpart, getprefix, getnamespacefromprefix, getprefixfromnamespace, gettypedef, serializetypedef, typetoform, wsdl, parsewsdl, getoperations, serializerpcparameters, serializetype, soap_fault, timestamp_to_iso8601, iso8601_to_timestamp, formatdump, lib_bwcheck, makeobj, b_writeit, popup, popout, getbindingdata, getmessagedata |
|
Public Method Summary |
void |
soapclient(string $endpoint, [ string $wsdl, string $portName ]) constructorWarning: documentation is missing.
|
mixed |
call(string $operation, [ array $params, string $namespace, string $soapAction, boolean $headers ]) calls method, returns PHP native typeWarning: documentation is missing.
|
array |
getOperationData(string $operation) get available data pertaining to an operationWarning: documentation is missing.
|
mixed |
send(string $msg, [ string $soapaction, integer $timeout ]) send the SOAP messageWarning: documentation is missing.
|
object SOAPx4 |
parseResponse(string $data) processes SOAP message returned from serverWarning: documentation is missing.
|
void |
setHeaders(string $headers) set the SOAP headersWarning: documentation is missing.
|
mixed |
getHeaders() get the response headersWarning: documentation is missing.
|
void |
setHTTPProxy(string $proxyhost, string $proxyport) set proxy info hereWarning: documentation is missing.
|
void |
setCredentials(string $username, string $pword) if authenticating, set user credentials hereWarning: documentation is missing.
|
object soap_proxy |
getProxy() dynamically creates proxy class, allowing user to directly call methods from wsdlWarning: documentation is missing.
|
|
Fields inherited from nusoap_base |
$soap_defencoding, $namespaces, $typemap, $xmlentities, $title, $version, $url, $operations, $headers, $request, $xml_encoding, $result, $faultcode, $faultactor, $faultstring, $faultdetail |
|
Public Field Summary |
string |
$fault fault related variables
|
|
|
|
Public Method Details |
soapclient |
public void soapclient(string $endpoint, [ string $wsdl, string $portName ])
|
|
constructor
Warning: documentation is missing.
|
Parameter |
|
string |
$endpoint |
|
|
SOAP server or WSDL URL |
|
|
string |
$wsdl |
= >>""<< |
|
optional, set to true if using WSDL |
|
|
string |
$portName |
= >>""<< |
|
optional portName in WSDL document |
|
Returns |
void |
|
call |
public mixed call(string $operation, [ array $params, string $namespace, string $soapAction, boolean $headers ])
|
|
calls method, returns PHP native type
Warning: documentation is missing.
|
Parameter |
|
string |
$operation |
|
|
SOAP server URL or path |
|
|
array |
$params |
= >>array()<< |
|
array of parameters, can be associative or not |
|
|
string |
$namespace |
= >>""<< |
|
optional method namespace |
|
|
string |
$soapAction |
= >>""<< |
|
optional SOAPAction value |
|
|
boolean |
$headers |
= >>false<< |
|
optional array of soapval objects for headers |
|
Returns |
mixed |
|
getOperationData |
public array getOperationData(string $operation)
|
|
get available data pertaining to an operation
Warning: documentation is missing.
|
Parameter |
|
string |
$operation |
|
|
operation name |
|
Returns |
array array of data pertaining to the operation |
|
send |
public mixed send(string $msg, [ string $soapaction, integer $timeout ])
|
|
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.
Warning: documentation is missing.
|
Parameter |
|
string |
$msg |
|
|
a SOAPx4 soapmsg object |
|
|
string |
$soapaction |
= >>""<< |
|
SOAPAction value |
|
|
integer |
$timeout |
= >>0<< |
|
set timeout in seconds |
|
Returns |
mixed native PHP types. |
|
parseResponse |
public object SOAPx4 parseResponse(string $data)
|
|
processes SOAP message returned from server
Warning: documentation is missing.
|
Parameter |
|
string |
$data |
|
|
response data from server |
|
Returns |
object SOAPx4 soapval object |
|
setHeaders |
public void setHeaders(string $headers)
|
|
set the SOAP headers
Warning: documentation is missing.
|
Parameter |
|
|
Returns |
void |
|
getHeaders |
public mixed getHeaders()
|
|
get the response headers
Warning: documentation is missing.
|
Returns |
mixed object SOAPx4 soapval object or empty if no headers |
|
setHTTPProxy |
public void setHTTPProxy(string $proxyhost, string $proxyport)
|
|
set proxy info here
Warning: documentation is missing.
|
Parameter |
|
|
|
|
Returns |
void |
|
setCredentials |
public void setCredentials(string $username, string $pword)
|
|
if authenticating, set user credentials here
Warning: documentation is missing.
|
Parameter |
|
|
|
|
Returns |
void |
|
getProxy |
public object soap_proxy getProxy()
|
|
dynamically creates proxy class, allowing user to directly call methods from wsdl
Warning: documentation is missing.
|
Returns |
object soap_proxy object |
|
|
Public Field Details |
$fault |
public string $fault
>> <<
fault related variables
|
|
|
|
|
|
|
PHPDoc 1.0beta |