|
ILIAS
release_10 Revision v10.1-43-ga1241a92c2f
|
parses a WSDL file, allows access to it's data, other utility methods. More...
Inheritance diagram for wsdl:
Collaboration diagram for wsdl:Public Member Functions | |
| __construct ($wsdl='', $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30, $curl_options=null, $use_curl=false) | |
| constructor More... | |
| fetchWSDL ($wsdl) | |
| fetches the WSDL document and parses it More... | |
| parseWSDL ($wsdl='') | |
| parses the wsdl document More... | |
| start_element ($parser, $name, $attrs) | |
| start-element handler More... | |
| end_element ($parser, $name) | |
| end-element handler More... | |
| character_data ($parser, $data) | |
| element content handler More... | |
| setCredentials ($username, $password, $authtype='basic', $certRequest=array()) | |
| if authenticating, set user credentials here More... | |
| getBindingData ($binding) | |
| getOperations ($bindingType='soap') | |
| returns an assoc array of operation names => operation data More... | |
| getOperationData ($operation, $bindingType='soap') | |
| returns an associative array of data necessary for calling an operation More... | |
| getOperationDataForSoapAction ($soapAction, $bindingType='soap') | |
| returns an associative array of data necessary for calling an operation More... | |
| getTypeDef ($type, $ns) | |
| returns an array of information about a given type returns false if no type exists by the given name More... | |
| webDescription () | |
| prints html description of services More... | |
| serialize ($debug=0) | |
| serialize the parsed wsdl More... | |
| parametersMatchWrapped ($type, &$parameters) | |
| determine whether a set of parameters are unwrapped when they are expect to be wrapped, Microsoft-style. More... | |
| serializeRPCParameters ($operation, $direction, $parameters, $bindingType='soap') | |
| serialize PHP values according to a WSDL message definition contrary to the method name, this is not limited to RPC More... | |
| serializeParameters ($operation, $direction, $parameters) | |
| serialize a PHP value according to a WSDL message definition More... | |
| serializeType ($name, $type, $value, $use='encoded', $encodingStyle=false, $unqualified=false) | |
| serializes a PHP value according a given type definition More... | |
| serializeComplexTypeAttributes ($typeDef, $value, $ns, $uqType) | |
| serializes the attributes for a complexType More... | |
| serializeComplexTypeElements ($typeDef, $value, $ns, $uqType, $use='encoded', $encodingStyle=false) | |
| serializes the elements for a complexType More... | |
| addComplexType ($name, $typeClass='complexType', $phpType='array', $compositor='', $restrictionBase='', $elements=array(), $attrs=array(), $arrayType='') | |
| adds an XML Schema complex type to the WSDL types More... | |
| addSimpleType ($name, $restrictionBase='', $typeClass='simpleType', $phpType='scalar', $enumeration=array()) | |
| adds an XML Schema simple type to the WSDL types More... | |
| addElement ($attrs) | |
| adds an element to the WSDL types More... | |
| addOperation ($name, $in=false, $out=false, $namespace=false, $soapaction=false, $style='rpc', $use='encoded', $documentation='', $encodingStyle='') | |
| register an operation with the server More... | |
Public Member Functions inherited from nusoap_base | |
| __construct () | |
| constructor More... | |
| getGlobalDebugLevel () | |
| gets the global debug level, which applies to future instances More... | |
| setGlobalDebugLevel ($level) | |
| sets the global debug level, which applies to future instances More... | |
| getDebugLevel () | |
| gets the debug level for this instance More... | |
| setDebugLevel ($level) | |
| sets the debug level for this instance More... | |
| debug ($string) | |
| adds debug data to the instance debug string with formatting More... | |
| appendDebug ($string) | |
| adds debug data to the instance debug string without formatting More... | |
| clearDebug () | |
| clears the current debug data for this instance More... | |
| & | getDebug () |
| gets the current debug data for this instance More... | |
| & | getDebugAsXMLComment () |
| gets the current debug data for this instance as an XML comment this may change the contents of the debug data More... | |
| expandEntities ($val) | |
| expands entities, e.g. More... | |
| getError () | |
| returns error string if present More... | |
| setError ($str) | |
| sets error string More... | |
| isArraySimpleOrStruct ($val) | |
| detect if array is a simple array or a struct (associative array) More... | |
| 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. More... | |
| serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/') | |
| serializes a message More... | |
| formatDump ($str) | |
| formats a string to be inserted into an HTML stream More... | |
| contractQname ($qname) | |
| contracts (changes namespace to prefix) a qualified name More... | |
| expandQname ($qname) | |
| expands (changes prefix to namespace) a qualified name More... | |
| getLocalPart ($str) | |
| returns the local part of a prefixed string returns the original string, if not prefixed More... | |
| getPrefix ($str) | |
| returns the prefix part of a prefixed string returns false, if not prefixed More... | |
| getNamespaceFromPrefix ($prefix) | |
| pass it a prefix, it returns a namespace More... | |
| getPrefixFromNamespace ($ns) | |
| returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace More... | |
| getmicrotime () | |
| returns the time in ODBC canonical form with microseconds More... | |
| varDump ($data) | |
| Returns a string with the output of var_dump. More... | |
| __toString () | |
| represents the object as a string More... | |
Data Fields | |
| $serviceName | |
| $opStatus | |
| $currentPortOperation | |
| $wsdl | |
| $schemas = array() | |
| $currentSchema | |
| $message = array() | |
| $complexTypes = array() | |
| $messages = array() | |
| $currentMessage | |
| $currentOperation | |
| $portTypes = array() | |
| $currentPortType | |
| $bindings = array() | |
| $currentBinding | |
| $ports = array() | |
| $currentPort | |
| $opData = array() | |
| $status = '' | |
| $documentation = false | |
| $endpoint = '' | |
| $import = array() | |
| $parser | |
| $position = 0 | |
| $depth = 0 | |
| $depth_array = array() | |
| $proxyhost = '' | |
| $proxyport = '' | |
| $proxyusername = '' | |
| $proxypassword = '' | |
| $timeout = 0 | |
| $response_timeout = 30 | |
| $curl_options = array() | |
| $use_curl = false | |
| $username = '' | |
| $password = '' | |
| $authtype = '' | |
| $certRequest = array() | |
Data Fields inherited from nusoap_base | |
| $title = 'NuSOAP' | |
| $version = '0.7.3' | |
| $revision = '$Revision$' | |
| $error_str = '' | |
| $debug_str = '' | |
| $charencoding = true | |
| $debugLevel | |
| $XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema' | |
| $soap_defencoding = 'UTF-8' | |
| $namespaces | |
| $usedNamespaces = array() | |
| $typemap | |
| $xmlEntities | |
parses a WSDL file, allows access to it's data, other utility methods.
also builds WSDL structures programmatically.
Definition at line 4630 of file nusoap.php.
| wsdl::__construct | ( | $wsdl = '', |
|
$proxyhost = false, |
|||
$proxyport = false, |
|||
$proxyusername = false, |
|||
$proxypassword = false, |
|||
$timeout = 0, |
|||
$response_timeout = 30, |
|||
$curl_options = null, |
|||
$use_curl = false |
|||
| ) |
constructor
| string | $wsdl | WSDL document URL |
| string | $proxyhost | |
| string | $proxyport | |
| string | $proxyusername | |
| string | $proxypassword | |
| integer | $timeout | set the connection timeout |
| integer | $response_timeout | set the response timeout |
| array | $curl_options | user-specified cURL options |
| boolean | $use_curl | try to use cURL public |
Definition at line 4691 of file nusoap.php.
References ILIAS\GlobalScreen\Provider\__construct(), and nusoap_base\debug().
Here is the call graph for this function:| wsdl::addComplexType | ( | $name, | |
$typeClass = 'complexType', |
|||
$phpType = 'array', |
|||
$compositor = '', |
|||
$restrictionBase = '', |
|||
$elements = array(), |
|||
$attrs = array(), |
|||
$arrayType = '' |
|||
| ) |
adds an XML Schema complex type to the WSDL types
| string | $name | |
| string | $typeClass | (complexType|simpleType|attribute) |
| string | $phpType | currently supported are array and struct (php assoc array) |
| string | $compositor | (all|sequence|choice) |
| string | $restrictionBase | namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array) |
| array | $elements | e.g. array ( name => array(name=>'',type=>'') ) |
| array | $attrs | e.g. array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]')) |
| string | $arrayType | as namespace:name (xsd:string) |
Definition at line 6397 of file nusoap.php.
References Vendor\Package\$a, Vendor\Package\$e, and nusoap_base\expandQname().
Here is the call graph for this function:| wsdl::addElement | ( | $attrs | ) |
adds an element to the WSDL types
| array | $attrs | attributes that must include name and type |
Definition at line 6460 of file nusoap.php.
| wsdl::addOperation | ( | $name, | |
$in = false, |
|||
$out = false, |
|||
$namespace = false, |
|||
$soapaction = false, |
|||
$style = 'rpc', |
|||
$use = 'encoded', |
|||
$documentation = '', |
|||
$encodingStyle = '' |
|||
| ) |
register an operation with the server
| string | $name | operation (method) name |
| array | $in | assoc array of input values: key = param name, value = param type |
| array | $out | assoc array of output values: key = param name, value = param type |
| string | $namespace | optional The namespace for the operation |
| string | $soapaction | optional The soapaction for the operation |
| string | $style | (rpc|document) optional The style for the operation Note: when 'document' is specified, parameter and return wrappers are created for you automatically |
| string | $use | (encoded|literal) optional The use for the parameters (cannot mix right now) |
| string | $documentation | optional The description to include in the WSDL |
| string | $encodingStyle | optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded) public |
Definition at line 6480 of file nusoap.php.
References $namespace, $out, nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), and nusoap_base\getPrefix().
Referenced by nusoap_server\register().
Here is the call graph for this function:
Here is the caller graph for this function:| wsdl::addSimpleType | ( | $name, | |
$restrictionBase = '', |
|||
$typeClass = 'simpleType', |
|||
$phpType = 'scalar', |
|||
$enumeration = array() |
|||
| ) |
adds an XML Schema simple type to the WSDL types
| string | $name | |
| string | $restrictionBase | namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array) |
| string | $typeClass | (should always be simpleType) |
| string | $phpType | (should always be scalar) |
| array | $enumeration | array of values |
Definition at line 6445 of file nusoap.php.
References nusoap_base\expandQname().
Here is the call graph for this function:| wsdl::character_data | ( | $parser, | |
| $data | |||
| ) |
element content handler
| string | $parser | XML parser object |
| string | $data | element content private |
Definition at line 5166 of file nusoap.php.
References $data.
| wsdl::end_element | ( | $parser, | |
| $name | |||
| ) |
end-element handler
| string | $parser | XML parser object |
| string | $name | element name private |
Definition at line 5135 of file nusoap.php.
References nusoap_base\appendDebug(), and nusoap_base\debug().
Here is the call graph for this function:| wsdl::fetchWSDL | ( | $wsdl | ) |
fetches the WSDL document and parses it
public
Definition at line 4713 of file nusoap.php.
References $data, $url, and nusoap_base\debug().
Referenced by nusoap_client\loadWSDL().
Here is the call graph for this function:
Here is the caller graph for this function:| wsdl::getBindingData | ( | $binding | ) |
Definition at line 5196 of file nusoap.php.
| wsdl::getOperationData | ( | $operation, | |
$bindingType = 'soap' |
|||
| ) |
returns an associative array of data necessary for calling an operation
| string | $operation | name of operation |
| string | $bindingType | type of binding eg: soap, soap12 |
Definition at line 5242 of file nusoap.php.
Referenced by nusoap_server\invoke_method(), and nusoap_server\verify_method().
Here is the caller graph for this function:| wsdl::getOperationDataForSoapAction | ( | $soapAction, | |
$bindingType = 'soap' |
|||
| ) |
returns an associative array of data necessary for calling an operation
| string | $soapAction | soapAction for operation |
| string | $bindingType | type of binding eg: soap, soap12 |
Definition at line 5274 of file nusoap.php.
Referenced by nusoap_server\invoke_method().
Here is the caller graph for this function:| wsdl::getOperations | ( | $bindingType = 'soap' | ) |
returns an assoc array of operation names => operation data
| string | $bindingType | eg: soap, smtp, dime (only soap and soap12 are currently supported) |
Definition at line 5210 of file nusoap.php.
Referenced by nusoap_client\checkWSDL().
Here is the caller graph for this function:| wsdl::getTypeDef | ( | $type, | |
| $ns | |||
| ) |
returns an array of information about a given type returns false if no type exists by the given name
typeDef = array( 'elements' => array(), // refs to elements array 'restrictionBase' => '', 'phpType' => '', 'order' => '(sequence|all)', 'attrs' => array() // refs to attributes array )
| string | $type | the type |
| string | $ns | namespace (not prefix) of the type |
Definition at line 5313 of file nusoap.php.
References nusoap_base\debug(), and nusoap_base\varDump().
Here is the call graph for this function:| wsdl::parametersMatchWrapped | ( | $type, | |
| & | $parameters | ||
| ) |
determine whether a set of parameters are unwrapped when they are expect to be wrapped, Microsoft-style.
| string | $type | the type (element name) of the wrapper |
| array | $parameters | the parameter values for the SOAP call |
Definition at line 5660 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\isArraySimpleOrStruct(), and nusoap_base\varDump().
Here is the call graph for this function:| wsdl::parseWSDL | ( | $wsdl = '' | ) |
parses the wsdl document
| string | $wsdl | path or URL private |
Definition at line 4817 of file nusoap.php.
References $data, $path, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getError(), and nusoap_base\setError().
Here is the call graph for this function:| wsdl::serialize | ( | $debug = 0 | ) |
serialize the parsed wsdl
| mixed | $debug | whether to put debug=1 in endpoint URL |
Definition at line 5512 of file nusoap.php.
References $_GET, $location, nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), and nusoap_base\getPrefixFromNamespace().
Referenced by nusoap_server\service().
Here is the call graph for this function:
Here is the caller graph for this function:| wsdl::serializeComplexTypeAttributes | ( | $typeDef, | |
| $value, | |||
| $ns, | |||
| $uqType | |||
| ) |
serializes the attributes for a complexType
| array | $typeDef | our internal representation of an XML schema type (or element) |
| mixed | $value | a native PHP value (parameter value) |
| string | $ns | the namespace of the type |
| string | $uqType | the local part of the type |
Definition at line 6231 of file nusoap.php.
References nusoap_base\debug(), nusoap_base\expandEntities(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), and nusoap_base\getPrefix().
Here is the call graph for this function:| wsdl::serializeComplexTypeElements | ( | $typeDef, | |
| $value, | |||
| $ns, | |||
| $uqType, | |||
$use = 'encoded', |
|||
$encodingStyle = false |
|||
| ) |
serializes the elements for a complexType
| array | $typeDef | our internal representation of an XML schema type (or element) |
| mixed | $value | a native PHP value (parameter value) |
| string | $ns | the namespace of the type |
| string | $uqType | the local part of the type |
| string | $use | use for part (encoded|literal) |
| string | $encodingStyle | SOAP encoding style for the value (if different than the enclosing style) |
Definition at line 6294 of file nusoap.php.
References nusoap_base\debug(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), nusoap_base\isArraySimpleOrStruct(), and nusoap_base\serialize_val().
Here is the call graph for this function:| wsdl::serializeParameters | ( | $operation, | |
| $direction, | |||
| $parameters | |||
| ) |
serialize a PHP value according to a WSDL message definition
TODO
| string | $operation | operation name |
| string | $direction | (input|output) |
| mixed | $parameters | parameter value(s) |
Definition at line 5849 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\isArraySimpleOrStruct(), nusoap_base\setError(), and nusoap_base\varDump().
Here is the call graph for this function:| wsdl::serializeRPCParameters | ( | $operation, | |
| $direction, | |||
| $parameters, | |||
$bindingType = 'soap' |
|||
| ) |
serialize PHP values according to a WSDL message definition contrary to the method name, this is not limited to RPC
TODO
| string | $operation | operation name |
| string | $direction | (input|output) |
| mixed | $parameters | parameter value(s) |
| string | $bindingType | (soap|soap12) |
Definition at line 5754 of file nusoap.php.
References $parts, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\isArraySimpleOrStruct(), nusoap_base\setError(), and nusoap_base\varDump().
Referenced by nusoap_client\call(), and nusoap_server\serialize_return().
Here is the call graph for this function:
Here is the caller graph for this function:| wsdl::serializeType | ( | $name, | |
| $type, | |||
| $value, | |||
$use = 'encoded', |
|||
$encodingStyle = false, |
|||
$unqualified = false |
|||
| ) |
serializes a PHP value according a given type definition
| string | $name | name of value (part or element) |
| string | $type | XML schema type of value (type or element) |
| mixed | $value | a native PHP value (parameter value) |
| string | $use | use for part (encoded|literal) |
| string | $encodingStyle | SOAP encoding style for the value (if different than the enclosing style) |
| boolean | $unqualified | a kludge for what should be XML namespace form handling |
Definition at line 5927 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\expandEntities(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), nusoap_base\getPrefixFromNamespace(), nusoap_base\serialize_val(), nusoap_base\setError(), and nusoap_base\varDump().
Here is the call graph for this function:| wsdl::setCredentials | ( | $username, | |
| $password, | |||
$authtype = 'basic', |
|||
$certRequest = array() |
|||
| ) |
if authenticating, set user credentials here
| string | $username | |
| string | $password | |
| string | $authtype | (basic|digest|certificate|ntlm) |
| array | $certRequest | (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, certpassword (optional), verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public |
Definition at line 5186 of file nusoap.php.
References nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().
Referenced by nusoap_client\loadWSDL().
Here is the call graph for this function:
Here is the caller graph for this function:| wsdl::start_element | ( | $parser, | |
| $name, | |||
| $attrs | |||
| ) |
start-element handler
| string | $parser | XML parser object |
| string | $name | element name |
| string | $attrs | associative array of attributes private |
Definition at line 4922 of file nusoap.php.
References $namespace, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\expandQname(), nusoap_base\getLocalPart(), and nusoap_base\getPrefixFromNamespace().
Here is the call graph for this function:| wsdl::webDescription | ( | ) |
prints html description of services
private
Definition at line 5370 of file nusoap.php.
References $_SERVER, Vendor\Package\$b, $data, and nusoap_base\setError().
Referenced by nusoap_server\service().
Here is the call graph for this function:
Here is the caller graph for this function:| wsdl::$authtype = '' |
Definition at line 4674 of file nusoap.php.
| wsdl::$bindings = array() |
Definition at line 4647 of file nusoap.php.
| wsdl::$certRequest = array() |
Definition at line 4675 of file nusoap.php.
| wsdl::$complexTypes = array() |
Definition at line 4641 of file nusoap.php.
| wsdl::$curl_options = array() |
Definition at line 4669 of file nusoap.php.
| wsdl::$currentBinding |
Definition at line 4648 of file nusoap.php.
| wsdl::$currentMessage |
Definition at line 4643 of file nusoap.php.
| wsdl::$currentOperation |
Definition at line 4644 of file nusoap.php.
| wsdl::$currentPort |
Definition at line 4650 of file nusoap.php.
| wsdl::$currentPortOperation |
Definition at line 4635 of file nusoap.php.
| wsdl::$currentPortType |
Definition at line 4646 of file nusoap.php.
| wsdl::$currentSchema |
Definition at line 4639 of file nusoap.php.
| wsdl::$depth = 0 |
Definition at line 4660 of file nusoap.php.
| wsdl::$depth_array = array() |
Definition at line 4661 of file nusoap.php.
| wsdl::$documentation = false |
Definition at line 4653 of file nusoap.php.
| wsdl::$endpoint = '' |
Definition at line 4654 of file nusoap.php.
| wsdl::$import = array() |
Definition at line 4656 of file nusoap.php.
| wsdl::$message = array() |
Definition at line 4640 of file nusoap.php.
| wsdl::$messages = array() |
Definition at line 4642 of file nusoap.php.
| wsdl::$opData = array() |
Definition at line 4651 of file nusoap.php.
| wsdl::$opStatus |
Definition at line 4634 of file nusoap.php.
| wsdl::$parser |
Definition at line 4658 of file nusoap.php.
| wsdl::$password = '' |
Definition at line 4673 of file nusoap.php.
| wsdl::$ports = array() |
Definition at line 4649 of file nusoap.php.
| wsdl::$portTypes = array() |
Definition at line 4645 of file nusoap.php.
| wsdl::$position = 0 |
Definition at line 4659 of file nusoap.php.
| wsdl::$proxyhost = '' |
Definition at line 4663 of file nusoap.php.
| wsdl::$proxypassword = '' |
Definition at line 4666 of file nusoap.php.
| wsdl::$proxyport = '' |
Definition at line 4664 of file nusoap.php.
| wsdl::$proxyusername = '' |
Definition at line 4665 of file nusoap.php.
| wsdl::$response_timeout = 30 |
Definition at line 4668 of file nusoap.php.
| wsdl::$schemas = array() |
Definition at line 4638 of file nusoap.php.
| wsdl::$serviceName |
Definition at line 4633 of file nusoap.php.
| wsdl::$status = '' |
Definition at line 4652 of file nusoap.php.
| wsdl::$timeout = 0 |
Definition at line 4667 of file nusoap.php.
| wsdl::$use_curl = false |
Definition at line 4670 of file nusoap.php.
| wsdl::$username = '' |
Definition at line 4672 of file nusoap.php.
| wsdl::$wsdl |
Definition at line 4636 of file nusoap.php.