nusoap_base Class Reference

nusoap_base More...

Inheritance diagram for nusoap_base:

Collaboration diagram for nusoap_base:

Public Member Functions
	__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
	$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

Detailed Description

nusoap_base

Author

Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com

Scott Nichol snich.nosp@m.ol@u.nosp@m.sers..nosp@m.sour.nosp@m.cefor.nosp@m.ge.n.nosp@m.et

Version

$Id$ public

Definition at line 94 of file nusoap.php.

Constructor & Destructor Documentation

__construct()

nusoap_base::__construct

(

)

constructor

public

Definition at line 235 of file nusoap.php.

References $GLOBALS.

    {
        $this->debugLevel = $GLOBALS['_transient']['static']['nusoap_base']->globalDebugLevel;
    }

Member Function Documentation

__toString()

nusoap_base::__toString

(

)

represents the object as a string

Returns

string public

Definition at line 922 of file nusoap.php.

References varDump().

    {
        return $this->varDump($this);
    }

Here is the call graph for this function:

appendDebug()

nusoap_base::appendDebug

(

$string

)

adds debug data to the instance debug string without formatting

Parameters

string

$string

debug data public

Definition at line 303 of file nusoap.php.

Referenced by soap_transport_http\__construct(), nusoap_server\__construct(), nusoap_client\__construct(), nusoap_client\_getProxyClassCode(), nusoap_xmlschema\addComplexType(), nusoap_xmlschema\addElement(), nusoap_xmlschema\addSimpleType(), nusoap_parser\buildVal(), nusoap_client\call(), nusoap_client\checkWSDL(), soap_transport_http\connect(), debug(), wsdl\end_element(), nusoap_server\invoke_method(), wsdl\parametersMatchWrapped(), nusoap_client\parseResponse(), wsdl\parseWSDL(), nusoap_xmlschema\schemaStartElement(), nusoap_client\send(), nusoap_server\serialize_return(), serialize_val(), serializeEnvelope(), wsdl\serializeParameters(), wsdl\serializeRPCParameters(), wsdl\serializeType(), nusoap_server\service(), soap_transport_http\setCredentials(), wsdl\setCredentials(), nusoap_client\setCredentials(), soap_transport_http\setCurlOption(), nusoap_client\setCurlOption(), nusoap_client\setHeaders(), and wsdl\start_element().

    {
        if ($this->debugLevel > 0) {
            // it would be nice to use a memory stream here to use
            // memory more efficiently
            $this->debug_str .= $string;
        }
    }

Here is the caller graph for this function:

clearDebug()

nusoap_base::clearDebug

(

)

clears the current debug data for this instance

public

Definition at line 317 of file nusoap.php.

Referenced by nusoap_server\__construct(), nusoap_client\call(), nusoap_client\checkWSDL(), and nusoap_server\serialize_return().

    {
        // it would be nice to use a memory stream here to use
        // memory more efficiently
        $this->debug_str = '';
    }

Here is the caller graph for this function:

contractQname()

nusoap_base::contractQname

(

$qname

)

contracts (changes namespace to prefix) a qualified name

Parameters

string

$qname

qname

Returns

string contracted qname private

Definition at line 767 of file nusoap.php.

References getPrefixFromNamespace().

    {
        // get element namespace
        //$this->xdebug("Contract $qname");
        if (strrpos($qname, ':')) {
            // get unqualified name
            $name = substr($qname, strrpos($qname, ':') + 1);
            // get ns
            $ns = substr($qname, 0, strrpos($qname, ':'));
            $p = $this->getPrefixFromNamespace($ns);
            if ($p) {
                return $p . ':' . $name;
            }
            return $qname;
        } else {
            return $qname;
        }
    }

Here is the call graph for this function:

debug()

nusoap_base::debug

(

$string

)

adds debug data to the instance debug string with formatting

Parameters

string

$string

debug data private

Definition at line 290 of file nusoap.php.

References appendDebug(), and getmicrotime().

Referenced by nusoap_xmlschema\__construct(), soap_transport_http\__construct(), nusoap_server\__construct(), wsdl\__construct(), nusoap_parser\__construct(), nusoap_client\__construct(), nusoap_client\_getProxyClassCode(), soap_transport_http\buildPayload(), nusoap_parser\buildVal(), nusoap_client\call(), nusoap_client\checkCookies(), nusoap_client\checkWSDL(), soap_transport_http\connect(), soap_transport_http\decodeChunked(), nusoap_parser\decodeSimple(), wsdl\end_element(), wsdl\fetchWSDL(), soap_transport_http\getCookiesForRequest(), nusoap_client\getOperationData(), nusoap_client\getProxy(), soap_transport_http\getResponse(), wsdl\getTypeDef(), nusoap_server\invoke_method(), nusoap_client\loadWSDL(), wsdl\parametersMatchWrapped(), nusoap_server\parse_http_headers(), nusoap_server\parse_request(), nusoap_xmlschema\parseFile(), nusoap_server\parseRequest(), nusoap_client\parseResponse(), nusoap_xmlschema\parseString(), wsdl\parseWSDL(), soap_transport_http\send(), nusoap_client\send(), nusoap_server\send_response(), soap_transport_http\sendRequest(), nusoap_server\serialize_return(), serialize_val(), wsdl\serializeComplexTypeAttributes(), wsdl\serializeComplexTypeElements(), serializeEnvelope(), wsdl\serializeParameters(), wsdl\serializeRPCParameters(), wsdl\serializeType(), nusoap_server\service(), soap_transport_http\setCredentials(), wsdl\setCredentials(), nusoap_client\setCredentials(), soap_transport_http\setCurlOption(), nusoap_client\setCurlOption(), nusoap_client\setEndpoint(), soap_transport_http\setHeader(), nusoap_client\setHeaders(), nusoap_client\setHTTPEncoding(), soap_transport_http\setProxy(), soap_transport_http\setURL(), nusoap_client\setUseCURL(), wsdl\start_element(), nusoap_parser\start_element(), soap_transport_http\unsetHeader(), nusoap_client\UpdateCookies(), nusoap_client\useHTTPPersistentConnection(), and nusoap_xmlschema\xdebug().

    {
        if ($this->debugLevel > 0) {
            $this->appendDebug($this->getmicrotime() . ' ' . get_class($this) . ": $string\n");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

expandEntities()

nusoap_base::expandEntities

(

$val

)

expands entities, e.g.

changes '<' to '<'.

Parameters

string

$val

The string in which to expand entities. private

Definition at line 361 of file nusoap.php.

Referenced by serialize_val(), wsdl\serializeComplexTypeAttributes(), and wsdl\serializeType().

    {
        if ($this->charencoding) {
            $val = str_replace('&', '&', $val);
            $val = str_replace("'", ''', $val);
            $val = str_replace('"', '"', $val);
            $val = str_replace('<', '&lt;', $val);
            $val = str_replace('>', '&gt;', $val);
        }
        return $val;
    }

Here is the caller graph for this function:

expandQname()

nusoap_base::expandQname

(

$qname

)

expands (changes prefix to namespace) a qualified name

Parameters

string

$qname

qname

Returns

string expanded qname private

Definition at line 793 of file nusoap.php.

Referenced by wsdl\addComplexType(), wsdl\addSimpleType(), nusoap_xmlschema\schemaStartElement(), and wsdl\start_element().

    {
        // get element prefix
        if (strpos($qname, ':') && !preg_match('/^http:\/\//', $qname)) {
            // get unqualified name
            $name = substr(strstr($qname, ':'), 1);
            // get ns prefix
            $prefix = substr($qname, 0, strpos($qname, ':'));
            if (isset($this->namespaces[$prefix])) {
                return $this->namespaces[$prefix] . ':' . $name;
            } else {
                return $qname;
            }
        } else {
            return $qname;
        }
    }

Here is the caller graph for this function:

formatDump()

nusoap_base::formatDump

(

$str

)

formats a string to be inserted into an HTML stream

Parameters

string

$str

The string to format

Returns

string The formatted string public

Deprecated:

Definition at line 754 of file nusoap.php.

    {
        $str = htmlspecialchars($str);
        return nl2br($str);
    }

getDebug()

& nusoap_base::getDebug

(

)

gets the current debug data for this instance

Returns

debug data public

Definition at line 330 of file nusoap.php.

References $debug_str.

Referenced by nusoap_server\__construct(), nusoap_client\call(), nusoap_client\checkWSDL(), nusoap_server\fault(), and nusoap_server\serialize_return().

    {
        // it would be nice to use a memory stream here to use
        // memory more efficiently
        return $this->debug_str;
    }

Here is the caller graph for this function:

getDebugAsXMLComment()

& nusoap_base::getDebugAsXMLComment

(

)

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

Returns

debug data as an XML comment public

Definition at line 344 of file nusoap.php.

Referenced by nusoap_server\send_response(), and nusoap_server\service().

    {
        // it would be nice to use a memory stream here to use
        // memory more efficiently
        while (strpos($this->debug_str, '--')) {
            $this->debug_str = str_replace('--', '- -', $this->debug_str);
        }
        $ret = "<!--\n" . $this->debug_str . "\n-->";
        return $ret;
    }

Here is the caller graph for this function:

getDebugLevel()

nusoap_base::getDebugLevel

(

)

gets the debug level for this instance

Returns

int Debug level 0-9, where 0 turns off public

Definition at line 268 of file nusoap.php.

References $debugLevel.

    {
        return $this->debugLevel;
    }

getError()

nusoap_base::getError

(

)

returns error string if present

Returns

mixed error string or false public

Definition at line 379 of file nusoap.php.

References $error_str.

Referenced by nusoap_server\__construct(), nusoap_client\_getProxyClassCode(), nusoap_client\call(), nusoap_client\checkWSDL(), nusoap_client\getOperationData(), nusoap_client\getProxy(), wsdl\parseWSDL(), nusoap_client\send(), nusoap_server\serialize_return(), and showResult().

    {
        if ($this->error_str != '') {
            return $this->error_str;
        }
        return false;
    }

Here is the caller graph for this function:

getGlobalDebugLevel()

nusoap_base::getGlobalDebugLevel

(

)

gets the global debug level, which applies to future instances

Returns

integer Debug level 0-9, where 0 turns off public

Definition at line 246 of file nusoap.php.

References $GLOBALS.

    {
        return $GLOBALS['_transient']['static']['nusoap_base']->globalDebugLevel;
    }

getLocalPart()

nusoap_base::getLocalPart

(

$str

)

returns the local part of a prefixed string returns the original string, if not prefixed

Parameters

string

$str

The prefixed string

Returns

string The local part public

Definition at line 819 of file nusoap.php.

Referenced by wsdl\addOperation(), nusoap_xmlschema\schemaEndElement(), nusoap_xmlschema\schemaStartElement(), wsdl\serialize(), wsdl\serializeComplexTypeAttributes(), wsdl\serializeComplexTypeElements(), wsdl\serializeType(), wsdl\start_element(), nusoap_parser\start_element(), and nusoap_xmlschema\typeToForm().

    {
        if ($sstr = strrchr($str, ':')) {
            // get unqualified name
            return substr($sstr, 1);
        } else {
            return $str;
        }
    }

Here is the caller graph for this function:

getmicrotime()

nusoap_base::getmicrotime

(

)

returns the time in ODBC canonical form with microseconds

Returns

string The time in ODBC canonical form with microseconds public

Definition at line 887 of file nusoap.php.

Referenced by debug().

    {
        if (function_exists('gettimeofday')) {
            $tod = gettimeofday();
            $sec = $tod['sec'];
            $usec = $tod['usec'];
        } else {
            $sec = time();
            $usec = 0;
        }
        return strftime('%Y-%m-%d %H:%M:%S', $sec) . '.' . sprintf('%06d', $usec);
    }

Here is the caller graph for this function:

getNamespaceFromPrefix()

nusoap_base::getNamespaceFromPrefix

(

$prefix

)

pass it a prefix, it returns a namespace

Parameters

string

$prefix

The prefix

Returns

mixed The namespace, false if no namespace has the specified prefix public

Definition at line 853 of file nusoap.php.

Referenced by wsdl\addOperation(), wsdl\parametersMatchWrapped(), nusoap_xmlschema\schemaStartElement(), wsdl\serialize(), wsdl\serializeComplexTypeAttributes(), wsdl\serializeComplexTypeElements(), and wsdl\serializeType().

    {
        if (isset($this->namespaces[$prefix])) {
            return $this->namespaces[$prefix];
        }
        //$this->setError("No namespace registered for prefix '$prefix'");
        return false;
    }

Here is the caller graph for this function:

getPrefix()

nusoap_base::getPrefix

(

$str

)

returns the prefix part of a prefixed string returns false, if not prefixed

Parameters

string

$str

The prefixed string

Returns

mixed The prefix or false if there is no prefix public

Definition at line 837 of file nusoap.php.

Referenced by nusoap_xmlschema\addElement(), wsdl\addOperation(), nusoap_xmlschema\schemaEndElement(), nusoap_xmlschema\schemaStartElement(), wsdl\serialize(), wsdl\serializeComplexTypeAttributes(), wsdl\serializeComplexTypeElements(), wsdl\serializeType(), and nusoap_parser\start_element().

    {
        if ($pos = strrpos($str, ':')) {
            // get prefix
            return substr($str, 0, $pos);
        }
        return false;
    }

Here is the caller graph for this function:

getPrefixFromNamespace()

nusoap_base::getPrefixFromNamespace

(

$ns

)

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

Parameters

string

$ns

The namespace

Returns

mixed The prefix, false if the namespace has no prefixes public

Definition at line 870 of file nusoap.php.

Referenced by nusoap_client\call(), contractQname(), nusoap_xmlschema\schemaStartElement(), wsdl\serialize(), nusoap_xmlschema\serializeSchema(), wsdl\serializeType(), and wsdl\start_element().

    {
        foreach ($this->namespaces as $p => $n) {
            if ($ns == $n || $ns == $p) {
                $this->usedNamespaces[$p] = $n;
                return $p;
            }
        }
        return false;
    }

Here is the caller graph for this function:

isArraySimpleOrStruct()

nusoap_base::isArraySimpleOrStruct

(

$val

)

detect if array is a simple array or a struct (associative array)

Parameters

mixed

$val

The PHP array

Returns

string (arraySimple|arrayStruct) private

Definition at line 405 of file nusoap.php.

Referenced by wsdl\parametersMatchWrapped(), serialize_val(), wsdl\serializeComplexTypeElements(), wsdl\serializeParameters(), and wsdl\serializeRPCParameters().

    {
        $keyList = array_keys($val);
        foreach ($keyList as $keyListValue) {
            if (!is_int($keyListValue)) {
                return 'arrayStruct';
            }
        }
        return 'arraySimple';
    }

Here is the caller graph for this function:

serialize_val()

nusoap_base::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.

Type information is not serialized if $use == 'literal'.

Parameters

mixed	$val	The value to serialize
string	$name	The name (local part) of the XML element
string	$type	The XML schema type (local part) for the element
string	$name_ns	The namespace for the name of the XML element
string	$type_ns	The namespace for the type of the element
array	$attributes	The attributes to serialize as name=>value pairs
string	$use	The WSDL "use" (encoded|literal)
boolean	$soapval	Whether this is called from soapval.

Returns

string The serialized element, possibly with child elements public

Definition at line 431 of file nusoap.php.

References appendDebug(), debug(), expandEntities(), isArraySimpleOrStruct(), and varDump().

Referenced by nusoap_client\call(), nusoap_fault\serialize(), soapval\serialize(), nusoap_server\serialize_return(), wsdl\serializeComplexTypeElements(), serializeEnvelope(), and wsdl\serializeType().

    {
        $this->debug("in serialize_val: name=$name, type=$type, name_ns=$name_ns, type_ns=$type_ns, use=$use, soapval=$soapval");
        $this->appendDebug('value=' . $this->varDump($val));
        $this->appendDebug('attributes=' . $this->varDump($attributes));

        if (is_object($val) && get_class($val) == 'soapval' && (! $soapval)) {
            $this->debug("serialize_val: serialize soapval");
            $xml = $val->serialize($use);
            $this->appendDebug($val->getDebug());
            $val->clearDebug();
            $this->debug("serialize_val of soapval returning $xml");
            return $xml;
        }
        // force valid name if necessary
        if (is_numeric($name)) {
            $name = '__numeric_' . $name;
        } elseif (! $name) {
            $name = 'noname';
        }
        // if name has ns, add ns prefix to name
        $xmlns = '';
        if ($name_ns) {
            $prefix = 'nu' . rand(1000, 9999);
            $name = $prefix . ':' . $name;
            $xmlns .= " xmlns:$prefix=\"$name_ns\"";
        }
        // if type is prefixed, create type prefix
        if ($type_ns != '' && $type_ns == $this->namespaces['xsd']) {
            // need to fix this. shouldn't default to xsd if no ns specified
            // w/o checking against typemap
            $type_prefix = 'xsd';
        } elseif ($type_ns) {
            $type_prefix = 'ns' . rand(1000, 9999);
            $xmlns .= " xmlns:$type_prefix=\"$type_ns\"";
        }
        // serialize attributes if present
        $atts = '';
        if ($attributes) {
            foreach ($attributes as $k => $v) {
                $atts .= " $k=\"" . $this->expandEntities($v) . '"';
            }
        }
        // serialize null value
        if (is_null($val)) {
            $this->debug("serialize_val: serialize null");
            if ($use == 'literal') {
                // TODO: depends on minOccurs
                $xml = "<$name$xmlns$atts/>";
                $this->debug("serialize_val returning $xml");
                return $xml;
            } else {
                if (isset($type) && isset($type_prefix)) {
                    $type_str = " xsi:type=\"$type_prefix:$type\"";
                } else {
                    $type_str = '';
                }
                $xml = "<$name$xmlns$type_str$atts xsi:nil=\"true\"/>";
                $this->debug("serialize_val returning $xml");
                return $xml;
            }
        }
        // serialize if an xsd built-in primitive type
        if ($type != '' && isset($this->typemap[$this->XMLSchemaVersion][$type])) {
            $this->debug("serialize_val: serialize xsd built-in primitive type");
            if (is_bool($val)) {
                if ($type == 'boolean') {
                    $val = $val ? 'true' : 'false';
                } elseif (! $val) {
                    $val = 0;
                }
            } elseif (is_string($val)) {
                $val = $this->expandEntities($val);
            }
            if ($use == 'literal') {
                $xml = "<$name$xmlns$atts>$val</$name>";
                $this->debug("serialize_val returning $xml");
                return $xml;
            } else {
                $xml = "<$name$xmlns xsi:type=\"xsd:$type\"$atts>$val</$name>";
                $this->debug("serialize_val returning $xml");
                return $xml;
            }
        }
        // detect type and serialize
        $xml = '';
        switch (true) {
            case (is_bool($val) || $type == 'boolean'):
                $this->debug("serialize_val: serialize boolean");
                if ($type == 'boolean') {
                    $val = $val ? 'true' : 'false';
                } elseif (! $val) {
                    $val = 0;
                }
                if ($use == 'literal') {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:boolean\"$atts>$val</$name>";
                }
                break;
            case (is_int($val) || is_long($val) || $type == 'int'):
                $this->debug("serialize_val: serialize int");
                if ($use == 'literal') {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:int\"$atts>$val</$name>";
                }
                break;
            case (is_float($val)|| is_double($val) || $type == 'float'):
                $this->debug("serialize_val: serialize float");
                if ($use == 'literal') {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:float\"$atts>$val</$name>";
                }
                break;
            case (is_string($val) || $type == 'string'):
                $this->debug("serialize_val: serialize string");
                $val = $this->expandEntities($val);
                if ($use == 'literal') {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:string\"$atts>$val</$name>";
                }
                break;
            case is_object($val):
                $this->debug("serialize_val: serialize object");
                if (get_class($val) == 'soapval') {
                    $this->debug("serialize_val: serialize soapval object");
                    $pXml = $val->serialize($use);
                    $this->appendDebug($val->getDebug());
                    $val->clearDebug();
                } else {
                    if (! $name) {
                        $name = get_class($val);
                        $this->debug("In serialize_val, used class name $name as element name");
                    } else {
                        $this->debug("In serialize_val, do not override name $name for element name for class " . get_class($val));
                    }
                    foreach (get_object_vars($val) as $k => $v) {
                        $pXml = isset($pXml) ? $pXml . $this->serialize_val($v, $k, false, false, false, false, $use) : $this->serialize_val($v, $k, false, false, false, false, $use);
                    }
                }
                if (isset($type) && isset($type_prefix)) {
                    $type_str = " xsi:type=\"$type_prefix:$type\"";
                } else {
                    $type_str = '';
                }
                if ($use == 'literal') {
                    $xml .= "<$name$xmlns$atts>$pXml</$name>";
                } else {
                    $xml .= "<$name$xmlns$type_str$atts>$pXml</$name>";
                }
                break;
                break;
            case (is_array($val) || $type):
                // detect if struct or array
                $valueType = $this->isArraySimpleOrStruct($val);
                if ($valueType=='arraySimple' || preg_match('/^ArrayOf/', $type)) {
                    $this->debug("serialize_val: serialize array");
                    $i = 0;
                    if (is_array($val) && count($val)> 0) {
                        foreach ($val as $v) {
                            if (is_object($v) && get_class($v) ==  'soapval') {
                                $tt_ns = $v->type_ns;
                                $tt = $v->type;
                            } elseif (is_array($v)) {
                                $tt = $this->isArraySimpleOrStruct($v);
                            } else {
                                $tt = gettype($v);
                            }
                            $array_types[$tt] = 1;
                            // TODO: for literal, the name should be $name
                            $xml .= $this->serialize_val($v, 'item', false, false, false, false, $use);
                            ++$i;
                        }
                        if (count($array_types) > 1) {
                            $array_typename = 'xsd:anyType';
                        } elseif (isset($tt) && isset($this->typemap[$this->XMLSchemaVersion][$tt])) {
                            if ($tt == 'integer') {
                                $tt = 'int';
                            }
                            $array_typename = 'xsd:' . $tt;
                        } elseif (isset($tt) && $tt == 'arraySimple') {
                            $array_typename = 'SOAP-ENC:Array';
                        } elseif (isset($tt) && $tt == 'arrayStruct') {
                            $array_typename = 'unnamed_struct_use_soapval';
                        } else {
                            // if type is prefixed, create type prefix
                            if ($tt_ns != '' && $tt_ns == $this->namespaces['xsd']) {
                                $array_typename = 'xsd:' . $tt;
                            } elseif ($tt_ns) {
                                $tt_prefix = 'ns' . rand(1000, 9999);
                                $array_typename = "$tt_prefix:$tt";
                                $xmlns .= " xmlns:$tt_prefix=\"$tt_ns\"";
                            } else {
                                $array_typename = $tt;
                            }
                        }
                        $array_type = $i;
                        if ($use == 'literal') {
                            $type_str = '';
                        } elseif (isset($type) && isset($type_prefix)) {
                            $type_str = " xsi:type=\"$type_prefix:$type\"";
                        } else {
                            $type_str = " xsi:type=\"SOAP-ENC:Array\" SOAP-ENC:arrayType=\"" . $array_typename . "[$array_type]\"";
                        }
                        // empty array
                    } else {
                        if ($use == 'literal') {
                            $type_str = '';
                        } elseif (isset($type) && isset($type_prefix)) {
                            $type_str = " xsi:type=\"$type_prefix:$type\"";
                        } else {
                            $type_str = " xsi:type=\"SOAP-ENC:Array\" SOAP-ENC:arrayType=\"xsd:anyType[0]\"";
                        }
                    }
                    // TODO: for array in literal, there is no wrapper here
                    $xml = "<$name$xmlns$type_str$atts>" . $xml . "</$name>";
                } else {
                    // got a struct
                    $this->debug("serialize_val: serialize struct");
                    if (isset($type) && isset($type_prefix)) {
                        $type_str = " xsi:type=\"$type_prefix:$type\"";
                    } else {
                        $type_str = '';
                    }
                    if ($use == 'literal') {
                        $xml .= "<$name$xmlns$atts>";
                    } else {
                        $xml .= "<$name$xmlns$type_str$atts>";
                    }
                    foreach ($val as $k => $v) {
                        // Apache Map
                        if ($type == 'Map' && $type_ns == 'http://xml.apache.org/xml-soap') {
                            $xml .= '<item>';
                            $xml .= $this->serialize_val($k, 'key', false, false, false, false, $use);
                            $xml .= $this->serialize_val($v, 'value', false, false, false, false, $use);
                            $xml .= '</item>';
                        } else {
                            $xml .= $this->serialize_val($v, $k, false, false, false, false, $use);
                        }
                    }
                    $xml .= "</$name>";
                }
                break;
            default:
                $this->debug("serialize_val: serialize unknown");
                $xml .= 'not detected, got ' . gettype($val) . ' for ' . $val;
                break;
        }
        $this->debug("serialize_val returning $xml");
        return $xml;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

serializeEnvelope()

nusoap_base::serializeEnvelope	(		$body,
			$headers = false,
			$namespaces = array(),
			$style = 'rpc',
			$use = 'encoded',
			$encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/'
	)

serializes a message

Parameters

string	$body	the XML of the SOAP body
mixed	$headers	optional string of XML with SOAP header content, or array of soapval objects for SOAP headers, or associative array
array	$namespaces	optional the namespaces used in generating the body and headers
string	$style	optional (rpc|document)
string	$use	optional (encoded|literal)
string	$encodingStyle	optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)

Returns

string the message public

Definition at line 698 of file nusoap.php.

References $namespaces, appendDebug(), debug(), serialize_val(), and varDump().

Referenced by nusoap_client\call(), and nusoap_server\serialize_return().

                                                                                                                                    ://schemas.xmlsoap.org/soap/encoding/')
    {
        // TODO: add an option to automatically run utf8_encode on $body and $headers
        // if $this->soap_defencoding is UTF-8.  Not doing this automatically allows
        // one to send arbitrary UTF-8 characters, not just characters that map to ISO-8859-1

        $this->debug("In serializeEnvelope length=" . strlen($body) . " body (max 1000 characters)=" . substr($body, 0, 1000) . " style=$style use=$use encodingStyle=$encodingStyle");
        $this->debug("headers:");
        $this->appendDebug($this->varDump($headers));
        $this->debug("namespaces:");
        $this->appendDebug($this->varDump($namespaces));

        // serialize namespaces
        $ns_string = '';
        foreach (array_merge($this->namespaces, $namespaces) as $k => $v) {
            $ns_string .= " xmlns:$k=\"$v\"";
        }
        if ($encodingStyle) {
            $ns_string = " SOAP-ENV:encodingStyle=\"$encodingStyle\"$ns_string";
        }

        // serialize headers
        if ($headers) {
            if (is_array($headers)) {
                $xml = '';
                foreach ($headers as $k => $v) {
                    if (is_object($v) && get_class($v) == 'soapval') {
                        $xml .= $this->serialize_val($v, false, false, false, false, false, $use);
                    } else {
                        $xml .= $this->serialize_val($v, $k, false, false, false, false, $use);
                    }
                }
                $headers = $xml;
                $this->debug("In serializeEnvelope, serialized array of headers to $headers");
            }
            $headers = "<SOAP-ENV:Header>" . $headers . "</SOAP-ENV:Header>";
        }
        // serialize envelope
        return
        '<?xml version="1.0" encoding="' . $this->soap_defencoding . '"?' . ">" .
        '<SOAP-ENV:Envelope' . $ns_string . ">" .
        $headers .
        "<SOAP-ENV:Body>" .
            $body .
        "</SOAP-ENV:Body>" .
        "</SOAP-ENV:Envelope>";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDebugLevel()

nusoap_base::setDebugLevel

(

$level

)

sets the debug level for this instance

Parameters

int

$level

Debug level 0-9, where 0 turns off public

Definition at line 279 of file nusoap.php.

    {
        $this->debugLevel = $level;
    }

setError()

nusoap_base::setError

(

$str

)

sets error string

Returns

boolean $string error string private

Definition at line 393 of file nusoap.php.

Referenced by nusoap_parser\__construct(), nusoap_client\_getProxyClassCode(), nusoap_client\call(), nusoap_client\checkWSDL(), nusoap_server\configureWSDL(), soap_transport_http\connect(), soap_transport_http\getResponse(), nusoap_server\parse_http_headers(), nusoap_xmlschema\parseFile(), nusoap_server\parseRequest(), nusoap_client\parseResponse(), nusoap_xmlschema\parseString(), wsdl\parseWSDL(), nusoap_server\register(), soap_transport_http\send(), nusoap_client\send(), soap_transport_http\sendRequest(), wsdl\serializeParameters(), wsdl\serializeRPCParameters(), wsdl\serializeType(), and wsdl\webDescription().

    {
        $this->error_str = $str;
    }

Here is the caller graph for this function:

setGlobalDebugLevel()

nusoap_base::setGlobalDebugLevel

(

$level

)

sets the global debug level, which applies to future instances

Parameters

int

$level

Debug level 0-9, where 0 turns off public

Definition at line 257 of file nusoap.php.

References $GLOBALS.

    {
        $GLOBALS['_transient']['static']['nusoap_base']->globalDebugLevel = $level;
    }

varDump()

nusoap_base::varDump

(

$data

)

Returns a string with the output of var_dump.

Parameters

mixed

$data

The variable to var_dump

Returns

string The output of var_dump public

Definition at line 907 of file nusoap.php.

References $data.

Referenced by soap_transport_http\__construct(), nusoap_server\__construct(), nusoap_client\__construct(), __toString(), nusoap_client\_getProxyClassCode(), nusoap_xmlschema\addComplexType(), nusoap_xmlschema\addElement(), nusoap_xmlschema\addSimpleType(), nusoap_parser\buildVal(), nusoap_client\call(), soap_transport_http\connect(), nusoap_xmlschema\getTypeDef(), wsdl\getTypeDef(), nusoap_server\invoke_method(), wsdl\parametersMatchWrapped(), nusoap_client\parseResponse(), nusoap_xmlschema\schemaStartElement(), nusoap_server\serialize_return(), serialize_val(), serializeEnvelope(), wsdl\serializeParameters(), wsdl\serializeRPCParameters(), wsdl\serializeType(), nusoap_server\service(), soap_transport_http\setCredentials(), wsdl\setCredentials(), nusoap_client\setCredentials(), soap_transport_http\setCurlOption(), nusoap_client\setCurlOption(), and nusoap_client\setHeaders().

    {
        ob_start();
        var_dump($data);
        $ret_val = ob_get_contents();
        ob_end_clean();
        return $ret_val;
    }

Here is the caller graph for this function:

Field Documentation

$charencoding

nusoap_base::$charencoding = true

Definition at line 138 of file nusoap.php.

$debug_str

nusoap_base::$debug_str = ''

Definition at line 130 of file nusoap.php.

Referenced by getDebug().

$debugLevel

nusoap_base::$debugLevel

Definition at line 145 of file nusoap.php.

Referenced by getDebugLevel().

$error_str

nusoap_base::$error_str = ''

Definition at line 123 of file nusoap.php.

Referenced by soap_transport_http\connect(), and getError().

$namespaces

nusoap_base::$namespaces

Initial value:

= array(
        'SOAP-ENV' => 'http://schemas.xmlsoap.org/soap/envelope/',
        'xsd' => 'http://www.w3.org/2001/XMLSchema',
        'xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
        'SOAP-ENC' => 'http://schemas.xmlsoap.org/soap/encoding/'
        )

Definition at line 172 of file nusoap.php.

Referenced by nusoap_xmlschema\__construct(), and serializeEnvelope().

$revision

nusoap_base::$revision = '$Revision$'

Definition at line 116 of file nusoap.php.

$soap_defencoding

nusoap_base::$soap_defencoding = 'UTF-8'

Definition at line 162 of file nusoap.php.

Referenced by nusoap_server\fault(), nusoap_server\getHTTPContentTypeCharset(), nusoap_client\getHTTPContentTypeCharset(), and nusoap_client\getProxy().

$title

nusoap_base::$title = 'NuSOAP'

Definition at line 102 of file nusoap.php.

$typemap

nusoap_base::$typemap

Initial value:

= array(
    'http://www.w3.org/2001/XMLSchema' => array(
        'string'=>'string','boolean'=>'boolean','float'=>'double','double'=>'double','decimal'=>'double',
        'duration'=>'','dateTime'=>'string','time'=>'string','date'=>'string','gYearMonth'=>'',
        'gYear'=>'','gMonthDay'=>'','gDay'=>'','gMonth'=>'','hexBinary'=>'string','base64Binary'=>'string',
        
        'anyType'=>'string','anySimpleType'=>'string',
        
        'normalizedString'=>'string','token'=>'string','language'=>'','NMTOKEN'=>'','NMTOKENS'=>'','Name'=>'','NCName'=>'','ID'=>'',
        'IDREF'=>'','IDREFS'=>'','ENTITY'=>'','ENTITIES'=>'','integer'=>'integer','nonPositiveInteger'=>'integer',
        'negativeInteger'=>'integer','long'=>'integer','int'=>'integer','short'=>'integer','byte'=>'integer','nonNegativeInteger'=>'integer',
        'unsignedLong'=>'','unsignedInt'=>'','unsignedShort'=>'','unsignedByte'=>'','positiveInteger'=>''),
    'http://www.w3.org/2000/10/XMLSchema' => array(
        'i4'=>'','int'=>'integer','boolean'=>'boolean','string'=>'string','double'=>'double',
        'float'=>'double','dateTime'=>'string',
        'timeInstant'=>'string','base64Binary'=>'string','base64'=>'string','ur-type'=>'array'),
    'http://www.w3.org/1999/XMLSchema' => array(
        'i4'=>'','int'=>'integer','boolean'=>'boolean','string'=>'string','double'=>'double',
        'float'=>'double','dateTime'=>'string',
        'timeInstant'=>'string','base64Binary'=>'string','base64'=>'string','ur-type'=>'array'),
    'http://soapinterop.org/xsd' => array('SOAPStruct'=>'struct'),
    'http://schemas.xmlsoap.org/soap/encoding/' => array('base64'=>'string','array'=>'array','Array'=>'array'),
    'http://xml.apache.org/xml-soap' => array('Map')
    )

Definition at line 194 of file nusoap.php.

$usedNamespaces

nusoap_base::$usedNamespaces = array()

Definition at line 185 of file nusoap.php.

Referenced by nusoap_client\call().

$version

nusoap_base::$version = '0.7.3'

Definition at line 109 of file nusoap.php.

$xmlEntities

nusoap_base::$xmlEntities

Initial value:

= array('quot' => '"','amp' => '&',
        'lt' => '<','gt' => '>','apos' => "'")

Definition at line 227 of file nusoap.php.

$XMLSchemaVersion

nusoap_base::$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'

Definition at line 153 of file nusoap.php.

Referenced by nusoap_parser\start_element().

---

The documentation for this class was generated from the following file:

• components/ILIAS/soap/lib/nusoap.php