Issues in nusoap.php (master) - Issues in master - XoopsModules25x/oledrion - Measure and Improve Code Quality continuously with Scrutinizer

Issues (608)

Security Analysis not enabled

File Inclusion
File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.
Regex Injection
Regex Injection enables an attacker to execute arbitrary code in your PHP process.
SQL Injection
SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.
Response Splitting
Response Splitting can be used to send arbitrary responses.
File Manipulation
File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.
Object Injection
Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.
File Exposure
File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.
XML Injection
XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.
Code Injection
Code Injection enables an attacker to execute arbitrary code on the server.
Variable Injection
Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.
XPath Injection
XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.
Other Vulnerability
This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.
Command Injection
Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.
LDAP Injection
LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.
Cross-Site Scripting
Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.
Header Injection
Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.
class/Gateways/Pec24/nusoap.php (149 issues)

Labels

Severity

<?php

//declare(strict_types=1);

/*

NuSOAP - Web Services Toolkit for PHP

Copyright (c) 2002 NuSphere Corporation

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

The NuSOAP project home is:
http://sourceforge.net/projects/nusoap/

The primary support for NuSOAP is the Help forum on the project home page.

If you have any questions or comments, please email:

Dietrich Ayala
[email protected]
http://dietrich.ganx4.com/nusoap

NuSphere Corporation
http://www.nusphere.com

*/

/*
 *  Some of the standards implmented in whole or part by NuSOAP:
 *
 *  SOAP 1.1 (http://www.w3.org/TR/2000/NOTE-SOAP-20000508/)
 *  WSDL 1.1 (http://www.w3.org/TR/2001/NOTE-wsdl-20010315)
 *  SOAP Messages With Attachments (http://www.w3.org/TR/SOAP-attachments)
 *  XML 1.0 (http://www.w3.org/TR/2006/REC-xml-20060816/)
 *  Namespaces in XML 1.0 (http://www.w3.org/TR/2006/REC-xml-names-20060816/)
 *  XML Schema 1.0 (http://www.w3.org/TR/xmlschema-0/)
 *  RFC 2045 Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies
 *  RFC 2068 Hypertext Transfer Protocol -- HTTP/1.1
 *  RFC 2617 HTTP Authentication: Basic and Digest Access Authentication
 */

/* load classes

// necessary classes
require_once('class.soapclient.php');
require_once('class.soap_val.php');
require_once('class.soap_parser.php');
require_once('class.soap_fault.php');

// transport classes
require_once('class.soap_transport_http.php');

// optional add-on classes
require_once('class.xmlschema.php');
require_once('class.wsdl.php');

// server class
require_once('class.soap_server.php');*/

// class variable emulation
// cf. http://www.webkreator.com/php/techniques/php-static-class-variables.html
$GLOBALS['_transient']['static']['nusoap_base']['globalDebugLevel'] = 9;

/**
 * Nusoap_base
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Nusoap_base
{
    /**
     * Identification for HTTP headers.
     *
     * @var string
     */
    protected $title = 'NuSOAP';
    /**
     * Version for HTTP headers.
     *
     * @var string
     */
    protected $version = '0.9.6';
    /**
     * CVS revision for HTTP headers.
     *
     * @var string
     */
    protected $revision = '$Revision: 1.123 $';
    /**
     * Current error string (manipulated by getError/setError)
     *
     * @var string
     */
    protected $error_str = '';
    /**
     * Current debug string (manipulated by debug/appendDebug/clearDebug/getDebug/getDebugAsXMLComment)
     *
     * @var string
     */
    private $debug_str = '';
    /**
     * Toggles automatic encoding of special characters as entities
     * (should always be true, I think)
     *
     * @var bool
     */
    private $charencoding = true;
    /**
     * The debug level for this instance
     *
     * @var int
     */
    private $debugLevel;

    /**
     * Set schema version
     *
     * @var string
     */
    public $XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema';

    /**
     * Charset encoding for outgoing messages
     *
     * @var string
     */
    public $soap_defencoding = 'ISO-8859-1';
    //var $soap_defencoding = 'UTF-8';

    /**
     * Namespaces in an array of prefix => uri
     *
     * This is "seeded" by a set of constants, but it may be altered by code
     *
     * @var array
     */
    public $namespaces = [
        '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/',
    ];

    /**
     * Namespaces used in the current context, e.g. during serialization
     *
     * @var array
     */
    protected $usedNamespaces = [];

    /**
     * XML Schema types in an array of uri => (array of xml type => php type)
     * is this legacy yet?
     * no, this is used by the nusoap_xmlschema class to verify type => namespace mappings.
     * @var array
     */
    public $typemap = [
        'http://www.w3.org/2001/XMLSchema'          => [
            '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',
            // abstract "any" types
            'anyType'            => 'string',
            'anySimpleType'      => 'string',
            // derived datatypes
            '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'       => [
            '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'          => [
            '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'                => ['SOAPStruct' => 'struct'],
        'http://schemas.xmlsoap.org/soap/encoding/' => [
            'base64' => 'string',
            'array'  => 'array',
            'Array'  => 'array',
        ],
        'http://xml.apache.org/xml-soap'            => ['Map'],
    ];

    /**
     * XML entities to convert
     *
     * @var array
     * @deprecated
     * @see      expandEntities
     */
    public $xmlEntities = [
        'quot' => '"',
        'amp'  => '&',
        'lt'   => '<',
        'gt'   => '>',
        'apos' => "'",
    ];

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->debugLevel = $GLOBALS['_transient']['static']['Nusoap_base']['globalDebugLevel'];
    }

    /**
     * Gets the global debug level, which applies to future instances
     *
     * @return int Debug level 0-9, where 0 turns off
     */
    public function getGlobalDebugLevel()
    {
        return $GLOBALS['_transient']['static']['Nusoap_base']['globalDebugLevel'];
    }

    /**
     * Sets the global debug level, which applies to future instances
     *
     * @param int $level Debug level 0-9, where 0 turns off
     */
    public function setGlobalDebugLevel($level)
    {
        $GLOBALS['_transient']['static']['Nusoap_base']['globalDebugLevel'] = $level;
    }

    /**
     * Gets the debug level for this instance
     *
     * @return int Debug level 0-9, where 0 turns off
     */
    public function getDebugLevel()
    {
        return $this->debugLevel;
    }

    /**
     * Sets the debug level for this instance
     *
     * @param int $level Debug level 0-9, where 0 turns off
     */
    public function setDebugLevel($level)
    {
        $this->debugLevel = $level;
    }

    /**
     * Adds debug data to the instance debug string with formatting
     *
     * @param string $string debug data
     */
    protected function debug($string)
    {
        if ($this->debugLevel > 0) {
            $this->appendDebug($this->getmicrotime() . ' ' . get_class($this) . ": $string\n");
        }
    }

    /**
     * Adds debug data to the instance debug string without formatting
     *
     * @param string $string debug data
     */
    public function appendDebug($string)
    {
        if ($this->debugLevel > 0) {
            // it would be nice to use a memory stream here to use
            // memory more efficiently
            $this->debug_str .= $string;
        }
    }

    /**
     * Clears the current debug data for this instance
     */
    public function clearDebug()
    {
        // it would be nice to use a memory stream here to use
        // memory more efficiently
        $this->debug_str = '';
    }

    /**
     * Gets the current debug data for this instance
     *
     * @return   string debug data
     */
    public function &getDebug()
    {
        // it would be nice to use a memory stream here to use
        // memory more efficiently
        return $this->debug_str;
    }

    /**
     * Gets the current debug data for this instance as an XML comment
     * this may change the contents of the debug data
     *
     * @return   string debug data as an XML comment
     */
    public function &getDebugAsXMLComment()
    {
        // it would be nice to use a memory stream here to use
        // memory more efficiently
        while (mb_strpos($this->debug_str, '--')) {
            $this->debug_str = str_replace('--', '- -', $this->debug_str);
        }
        $ret = "<!--\n" . $this->debug_str . "\n-->";

        return $ret;
    }

    /**
     * Expands entities, e.g. changes '<' to '&lt;'.
     *
     * @param string $val The string in which to expand entities.
     * @return mixed|string
     */
    protected function expandEntities($val)
    {
        if ($this->charencoding) {
            $val = str_replace('&', '&amp;', $val);
            $val = str_replace("'", '&apos;', $val);
            $val = str_replace('"', '&quot;', $val);
            $val = str_replace('<', '&lt;', $val);
            $val = str_replace('>', '&gt;', $val);
        }

        return $val;
    }

    /**
     * Returns error string if present
     *
     * @return mixed error string or false
     */
    public function getError()
    {
        if ('' !== $this->error_str) {
            return $this->error_str;
        }

        return false;
    }

    /**
     * Sets error string
     *
     * @param string $str
     */
    protected function setError($str)
    {
        $this->error_str = $str;
    }

    /**
     * Detect if array is a simple array or a struct (associative array)
     *
     * @param  mixed $val The PHP array
     * @return string (arraySimple|arrayStruct)
     */
    protected function isArraySimpleOrStruct($val)
    {
        $keyList = array_keys($val);
        foreach ($keyList as $keyListValue) {
            if (!is_int($keyListValue)) {
                return 'arrayStruct';
            }
        }

        return 'arraySimple';
    }

    /**
     * Serializes PHP values in accordance w/ section 5. Type information is
     * not serialized if $use == 'literal'.
     *
     * @param  mixed            $val        The value to serialize
     * @param  bool|string      $name       The name (local part) of the XML element
     * @param  bool|string      $type       The XML schema type (local part) for the element
     * @param  bool|string      $name_ns    The namespace for the name of the XML element
     * @param  bool|string      $type_ns    The namespace for the type of the element
     * @param bool|string|array $attributes The attributes to serialize as name=>value pairs
     * @param  string           $use        The WSDL "use" (encoded|literal)
     * @param    bool           $soapval    Whether this is called from Soapval.
     * @return string      The serialized element, possibly with child elements
     */
    public function serialize_val(
        $val,
        $name = false,
        $type = false,
        $name_ns = false,
        $type_ns = false,
        $attributes = false,
        $use = 'encoded',
        $soapval = false)
    {
        $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) && 'Soapval' === get_class($val) && (!$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' . mt_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' . mt_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 (null === $val) {
            $this->debug('serialize_val: serialize null');
            if ('literal' === $use) {
                // TODO: depends on minOccurs
                $xml = "<$name$xmlns$atts>";
                $this->debug("serialize_val returning $xml");

                return $xml;
            }
            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 ('boolean' === $type) {
                    $val = $val ? 'true' : 'false';
                } elseif (!$val) {
                    $val = 0;
                }
            } elseif (is_string($val)) {
                $val = $this->expandEntities($val);
            }
            if ('literal' === $use) {
                $xml = "<$name$xmlns$atts>$val</$name>";
                $this->debug("serialize_val returning $xml");

                return $xml;
            }
            $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) || 'boolean' === $type):
                $this->debug('serialize_val: serialize boolean');
                if ('boolean' === $type) {
                    $val = $val ? 'true' : 'false';
                } elseif (!$val) {
                    $val = 0;
                }
                if ('literal' === $use) {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:boolean\"$atts>$val</$name>";
                }

                break;
            case (is_int($val) || is_int($val) || 'int' === $type):
                $this->debug('serialize_val: serialize int');
                if ('literal' === $use) {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:int\"$atts>$val</$name>";
                }

                break;
            case (is_float($val) || is_float($val) || 'float' === $type):
                $this->debug('serialize_val: serialize float');
                if ('literal' === $use) {
                    $xml .= "<$name$xmlns$atts>$val</$name>";
                } else {
                    $xml .= "<$name$xmlns xsi:type=\"xsd:float\"$atts>$val</$name>";
                }

                break;
            case (is_string($val) || 'string' === $type):
                $this->debug('serialize_val: serialize string');
                $val = $this->expandEntities($val);
                if ('literal' === $use) {
                    $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 ('Soapval' === get_class($val)) {
                    $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);
                    }
                }
                $type_str = '';
                if (isset($type) && isset($type_prefix)) {
                    $type_str = " xsi:type=\"$type_prefix:$type\"";
                }
                if ('literal' === $use) {
                    $xml .= "<$name$xmlns$atts>$pXml</$name>";

                } else {
                    $xml .= "<$name$xmlns$type_str$atts>$pXml</$name>";
                }

                break;
            case (is_array($val) || $type):
                // detect if struct or array
                $array_types = [];
                $tt_ns       = $tt = '';
                $valueType   = $this->isArraySimpleOrStruct($val);
                if ('arraySimple' === $valueType || preg_match('/^ArrayOf/', $type)) {
                if ('arraySimple' === $valueType || preg_match('/^ArrayOf/', /** @scrutinizer ignore-type */ $type)) {
                    $this->debug('serialize_val: serialize array');
                    $i = 0;
                    if ($val && is_array($val)) {
                        foreach ($val as $v) {
                            if (is_object($v) && 'Soapval' === get_class($v)) {
                                $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 (is_array($array_types) && count($array_types) > 1) {
                            $array_typename = 'xsd:anyType';
                        } elseif (isset($tt) && isset($this->typemap[$this->XMLSchemaVersion][$tt])) {
                            if ('integer' === $tt) {
                                $tt = 'int';
                            }
                            $array_typename = 'xsd:' . $tt;
                        } elseif (isset($tt) && 'arraySimple' === $tt) {
                            $array_typename = 'SOAP-ENC:Array';
                        } elseif (isset($tt) && 'arrayStruct' === $tt) {
                            $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' . mt_rand(1000, 9999);
                                $array_typename = "$tt_prefix:$tt";
                                $xmlns          .= " xmlns:$tt_prefix=\"$tt_ns\"";
                            } else {
                                $array_typename = $tt;
                            }
                        }
                        $array_type = $i;
                        if ('literal' === $use) {
                            $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 {
                        $type_str = ' xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:anyType[0]"';
                        if ('literal' === $use) {
                            $type_str = '';
                        } elseif (isset($type) && isset($type_prefix)) {
                            $type_str = " xsi:type=\"$type_prefix:$type\"";
                        }
                    }
                    // 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');
                    $type_str = '';
                    if (isset($type) && isset($type_prefix)) {
                        $type_str = " xsi:type=\"$type_prefix:$type\"";
                    }
                    if ('literal' === $use) {
                        $xml .= "<$name$xmlns$atts>";
                    } else {
                        $xml .= "<$name$xmlns$type_str$atts>";
                    }
                    foreach ($val as $k => $v) {
                        // Apache Map
                        if ('Map' === $type && 'http://xml.apache.org/xml-soap' === $type_ns) {
                            $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;
    }

    /**
     * Serializes a message
     *
     * @param  string $body          the XML of the SOAP body
     * @param mixed   $headers       optional string of XML with SOAP header content, or array of Soapval objects for SOAP headers, or associative array
     * @param  array  $namespaces    optional the namespaces used in generating the body and headers
     * @param  string $style         optional (rpc|document)
     * @param  string $use           optional (encoded|literal)
     * @param  string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)
     * @return string the message
     */
    public function serializeEnvelope(
        $body,
        $headers = false,
        $namespaces = [],
        $style = 'rpc',
        $use = 'encoded',
        $encodingStyle = 'http://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=' . mb_strlen($body) . ' body (max 1000 characters)=' . mb_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) && 'Soapval' === get_class($v)) {
                        $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>';
        return '<?xml version="1.0" encoding="' . $this->soap_defencoding . '"?' . '>' . '<SOAP-ENV:Envelope' . $ns_string . '>' . /** @scrutinizer ignore-type */ $headers . '<SOAP-ENV:Body>' . $body . '</SOAP-ENV:Body>' . '</SOAP-ENV:Envelope>';
    }

    /**
     * Formats a string to be inserted into an HTML stream
     *
     * @param  string $str The string to format
     * @return string The formatted string
     * @deprecated
     */
    public function formatDump($str)
    {
        $str = htmlspecialchars($str, ENT_QUOTES | ENT_HTML5);

        return nl2br($str);
    }

    /**
     * Contracts (changes namespace to prefix) a qualified name
     *
     * @param  string $qname qname
     * @return string contracted qname
     */
    protected function contractQName($qname)
    {
        // get element namespace
        //$this->xdebug("Contract $qname");
        if (mb_strrpos($qname, ':')) {
            // get unqualified name
            $name = mb_substr($qname, mb_strrpos($qname, ':') + 1);
            // get ns
            $ns = mb_substr($qname, 0, mb_strrpos($qname, ':'));
            $p  = $this->getPrefixFromNamespace($ns);
            if ($p) {
                return $p . ':' . $name;
            }

            return $qname;
        }

        return $qname;
    }

    /**
     * Expands (changes prefix to namespace) a qualified name
     *
     * @param  string $qname qname
     * @return string expanded qname
     */
    protected function expandQname($qname)
    {
        // get element prefix
        if (mb_strpos($qname, ':') && !preg_match('/^http:\/\//', $qname)) {
            // get unqualified name
            $name = mb_substr(mb_strstr($qname, ':'), 1);
            // get ns prefix
            $prefix = mb_substr($qname, 0, mb_strpos($qname, ':'));
            if (isset($this->namespaces[$prefix])) {
                return $this->namespaces[$prefix] . ':' . $name;
            }

            return $qname;
        }

        return $qname;
    }

    /**
     * Returns the local part of a prefixed string
     * Returns the original string, if not prefixed
     *
     * @param  string $str The prefixed string
     * @return string The local part
     */
    public function getLocalPart($str)
    {
        if (false !== ($sstr = mb_strrchr($str, ':'))) {
            // get unqualified name
            return mb_substr($sstr, 1);
        }

        return $str;
    }

    /**
     * Returns the prefix part of a prefixed string
     * Returns false, if not prefixed
     *
     * @param  string $str The prefixed string
     * @return mixed  The prefix or false if there is no prefix
     */
    public function getPrefix($str)
    {
        if (false !== ($pos = mb_strrpos($str, ':'))) {
            // get prefix
            return mb_substr($str, 0, $pos);
        }

        return false;
    }

    /**
     * Pass it a prefix, it returns a namespace
     *
     * @param  string $prefix The prefix
     * @return mixed  The namespace, false if no namespace has the specified prefix
     */
    public function getNamespaceFromPrefix($prefix)
    {
        if (isset($this->namespaces[$prefix])) {
            return $this->namespaces[$prefix];
        }
        //$this->setError("No namespace registered for prefix '$prefix'");
        return false;
    }

    /**
     * Returns the prefix for a given namespace (or prefix)
     * or false if no prefixes registered for the given namespace
     *
     * @param  string $ns The namespace
     * @return mixed  The prefix, false if the namespace has no prefixes
     */
    public function getPrefixFromNamespace($ns)
    {
        foreach ($this->namespaces as $p => $n) {
            if ($ns === $n || $ns === $p) {
                $this->usedNamespaces[$p] = $n;

                return $p;
            }
        }

        return false;
    }

    /**
     * Returns the time in ODBC canonical form with microseconds
     *
     * @return string The time in ODBC canonical form with microseconds
     */
    public function getmicrotime()
    {
        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);
    }

    /**
     * Returns a string with the output of var_dump
     *
     * @param  mixed $data The variable to var_dump
     * @return string The output of var_dump
     */
    public function varDump($data)
    {
        ob_start();
        var_dump($data);

        $ret_val = ob_get_contents();
        ob_end_clean();

        return $ret_val;
    }

    /**
     * Represents the object as a string
     *
     * @return string
     */
    public function __toString()
    {
        return $this->varDump($this);
    }
}

// XML Schema Datatype Helper Functions

//xsd:dateTime helpers

/**
 * Convert unix timestamp to ISO 8601 compliant date string
 *
 * @param  int  $timestamp Unix time stamp
 * @param  bool $utc       Whether the time stamp is UTC or local
 * @return mixed   ISO 8601 date string or false
 */
function timestamp_to_iso8601($timestamp, $utc = true)
{
    $datestr = date('Y-m-d\TH:i:sO', $timestamp);
    $pos     = mb_strrpos($datestr, '+');
    if (false === $pos) {
        $pos = mb_strrpos($datestr, '-');
    }
    if (false !== $pos) {
        if (mb_strlen($datestr) === $pos + 5) {
            $datestr = mb_substr($datestr, 0, $pos + 3) . ':' . mb_substr($datestr, -2);
        }
    }
    if ($utc) {
        $pattern = '/' . '([0-9]{4})-' .    // centuries & years CCYY-
                   '([0-9]{2})-' .    // months MM-
                   '([0-9]{2})' .    // days DD
                   'T' .            // separator T
                   '([0-9]{2}):' .    // hours hh:
                   '([0-9]{2}):' .    // minutes mm:
                   '([0-9]{2})(\.[0-9]*)?' . // seconds ss.ss...
                   '(Z|[+\-][0-9]{2}:?[0-9]{2})?' . // Z to indicate UTC, -/+HH:MM:SS.SS... for local tz's
                   '/';
        if (preg_match($pattern, $datestr, $regs)) {
            return sprintf('%04d-%02d-%02dT%02d:%02d:%02dZ', $regs[1], $regs[2], $regs[3], $regs[4], $regs[5], $regs[6]);
        }

        return false;
    }

    return $datestr;
}

/**
 * Convert ISO 8601 compliant date string to unix timestamp
 *
 * @param  string $datestr ISO 8601 compliant date string
 * @return mixed  Unix timestamp (int) or false
 */
function iso8601_to_timestamp($datestr)
{
    $pattern = '/' . '([0-9]{4})-' .    // centuries & years CCYY-
               '([0-9]{2})-' .    // months MM-
               '([0-9]{2})' .    // days DD
               'T' .            // separator T
               '([0-9]{2}):' .    // hours hh:
               '([0-9]{2}):' .    // minutes mm:
               '([0-9]{2})(\.[0-9]+)?' . // seconds ss.ss...
               '(Z|[+\-][0-9]{2}:?[0-9]{2})?' . // Z to indicate UTC, -/+HH:MM:SS.SS... for local tz's
               '/';
    if (preg_match($pattern, $datestr, $regs)) {
        // not utc
        if ('Z' !== $regs[8]) {
            $op = mb_substr($regs[8], 0, 1);
            $h  = mb_substr($regs[8], 1, 2);
            $m  = mb_substr($regs[8], mb_strlen($regs[8]) - 2, 2);
            if ('-' === $op) {
                $regs[4] += $h;
                $regs[5] += $m;
            } elseif ('+' === $op) {
                $regs[4] -= $h;
                $regs[5] -= $m;
            }
        }

        return gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
        //      return strtotime("$regs[1]-$regs[2]-$regs[3] $regs[4]:$regs[5]:$regs[6]Z");
    }

    return false;
}

/**
 * Sleeps some number of microseconds
 *
 * @param string $usec the number of microseconds to sleep
 * @deprecated
 */
function usleepWindows($usec)
{
    $start = gettimeofday();
    do {
        $stop       = gettimeofday();
        $timePassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
    } while ($timePassed < $usec);
}

/**
 * Contains information for a SOAP fault.
 * Mainly used for returning faults from deployed functions
 * in a server instance.
 * @author   Dietrich Ayala <[email protected]>
 */
class Nusoap_fault extends Nusoap_base
{
    /**
     * The fault code (client|server)
     * @var string
     */
    private $faultcode;
    /**
     * The fault actor
     * @var string
     */
    private $faultactor;
    /**
     * The fault string, a description of the fault
     * @var string
     */
    private $faultstring;
    /**
     * The fault detail, typically a string or array of string
     * @var mixed
     */
    private $faultdetail;

    /**
     * Constructor
     *
     * @param string $faultcode   (SOAP-ENV:Client | SOAP-ENV:Server)
     * @param string $faultactor  only used when msg routed between multiple actors
     * @param string $faultstring human readable error message
     * @param mixed  $faultdetail detail, typically a string or array of string
     */
    public function __construct($faultcode, $faultactor = '', $faultstring = '', $faultdetail = '')
    {
        parent::__construct();
        $this->faultcode   = $faultcode;
        $this->faultactor  = $faultactor;
        $this->faultstring = $faultstring;
        $this->faultdetail = $faultdetail;
    }

    /**
     * Serialize a fault
     *
     * @return string The serialization of the fault instance.
     */
    public function serialize()
    {
        $ns_string = '';
        foreach ($this->namespaces as $k => $v) {
            $ns_string .= "\n  xmlns:$k=\"$v\"";
        }
        $return_msg = '<?xml version="1.0" encoding="'
                      . $this->soap_defencoding
                      . '"?>'
                      . '<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"'
                      . $ns_string
                      . ">\n"
                      . '<SOAP-ENV:Body>'
                      . '<SOAP-ENV:Fault>'
                      . $this->serialize_val($this->faultcode, 'faultcode')
                      . $this->serialize_val($this->faultactor, 'faultactor')
                      . $this->serialize_val($this->faultstring, 'faultstring')
                      . $this->serialize_val($this->faultdetail, 'detail')
                      . '</SOAP-ENV:Fault>'
                      . '</SOAP-ENV:Body>'
                      . '</SOAP-ENV:Envelope>';

        return $return_msg;
    }
}

/**
 * Backward compatibility
 */
class Soap_fault extends Nusoap_fault
{
}

/**
 * Parses an XML Schema, allows access to it's data, other utility methods.
 * imperfect, no validation... yet, but quite functional.
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Nusoap_xmlschema extends Nusoap_base
{
    // files
    public $schema = '';
    public $xml    = '';
    // namespaces
    public $enclosingNamespaces;
    // schema info
    public $schemaInfo            = [];
    public $schemaTargetNamespace = '';
    // types, elements, attributes defined by the schema
    public $attributes       = [];
    public $complexTypes     = [];
    public $complexTypeStack = [];
    public $currentComplexType;
    public $elements         = [];
    public $elementStack     = [];
    public $currentElement;
    public $simpleTypes      = [];
    public $simpleTypeStack  = [];
    public $currentSimpleType;
    // imports
    public $imports = [];
    // parser vars
    public $parser;
    public $position         = 0;
    public $depth            = 0;
    public $depth_array      = [];
    public $message          = [];
    public $defaultNamespace = [];

    /**
     * Constructor
     *
     * @param string       $schema     schema document URI
     * @param string       $xml        xml document URI
     * @param array|string $namespaces namespaces defined in enclosing XML
     */
    public function __construct($schema = '', $xml = '', $namespaces = [])
    {
        parent::__construct();
        $this->debug('Nusoap_xmlschema class instantiated, inside constructor');
        // files
        $this->schema = $schema;
        $this->xml    = $xml;
        // namespaces
        $this->enclosingNamespaces = $namespaces;
        $this->namespaces          = array_merge($this->namespaces, $namespaces);
        $this->namespaces          = array_merge($this->namespaces, /** @scrutinizer ignore-type */ $namespaces);
        // parse schema file
        if ('' !== $schema) {
            $this->debug('initial schema file: ' . $schema);
            $this->parseFile($schema, 'schema');
        }

        // parse xml file
        if ('' !== $xml) {
            $this->debug('initial xml file: ' . $xml);
            $this->parseFile($xml, 'xml');
        }
    }

    /**
     * Parse an XML file
     *
     * @param  string $xml  path/URL to XML file
     * @param  string $type (schema | xml)
     * @return bool
     */
    public function parseFile($xml, $type)
    {
        // parse xml file
        if ('' !== $xml) {
            $xmlStr = @file_get_contents($xml);
            if ('' === $xmlStr) {
                $msg = 'Error reading XML from ' . $xml;
                $this->setError($msg);
                $this->debug($msg);

                return false;
            }

            $this->debug("parsing $xml");
            $this->parseString($xmlStr, $type);
            $this->parseString(/** @scrutinizer ignore-type */ $xmlStr, $type);
            $this->debug("done parsing $xml");

            return true;
        }

        return false;
    }

    /**
     * Parse an XML string
     *
     * @param string $xml  path or URL
     * @param string $type (schema|xml)
     */
    private function parseString($xml, $type)
    {
        // parse xml string
        if ('' !== $xml) {
            // Create an XML parser.
            $this->parser = xml_parser_create();
            // Set the options for parsing the XML data.
            xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
            // Set the object for the parser.
            xml_set_object($this->parser, $this);
            // Set the element handlers for the parser.
            if ('schema' === $type) {
                xml_set_element_handler($this->parser, 'schemaStartElement', 'schemaEndElement');
                xml_set_character_data_handler($this->parser, 'schemaCharacterData');
            } elseif ('xml' === $type) {
                xml_set_element_handler($this->parser, 'xmlStartElement', 'xmlEndElement');
                xml_set_character_data_handler($this->parser, 'xmlCharacterData');
            }

            // Parse the XML file.
            if (!xml_parse($this->parser, $xml, true)) {
                // Display an error message.
                $errstr = sprintf('XML error parsing XML schema on line %d: %s', xml_get_current_line_number($this->parser), xml_error_string(xml_get_error_code($this->parser)));
                $this->debug($errstr);
                $this->debug("XML payload:\n" . $xml);
                $this->setError($errstr);
            }

            xml_parser_free($this->parser);
            unset($this->parser);
        } else {
            $this->debug('no xml passed to parseString()!!');
            $this->setError('no xml passed to parseString()!!');
        }
    }

    /**
     * Gets a type name for an unnamed type
     * @param    string $ename Element name
     * @return string A type name for an unnamed type
     */
    private function CreateTypeName($ename)
    {
        $scope = '';
        for ($i = 0, $iMax = count($this->complexTypeStack); $i < $iMax; ++$i) {
            $scope .= $this->complexTypeStack[$i] . '_';
        }

        return $scope . $ename . '_ContainedType';
    }

    /**
     * Start-element handler
     *
     * @param string          $parser XML parser object
     * @param string          $name   element name
     * @param    string|array $attrs  associative array of attributes
     */
    public function schemaStartElement($parser, $name, $attrs)
    public function schemaStartElement(/** @scrutinizer ignore-unused */ $parser, $name, $attrs)
    {
        // position in the total number of elements, starting from 0
        $eAttrs = [];
        $aname  = '';
        $pos    = $this->position++;
        $depth  = $this->depth++;
        // set self as current value for this depth
        $this->depth_array[$depth] = $pos;
        $this->message[$pos]       = ['cdata' => ''];
        if ($depth > 0) {
            $this->defaultNamespace[$pos] = $this->defaultNamespace[$this->depth_array[$depth - 1]];
        } else {
            $this->defaultNamespace[$pos] = false;
        }

        // get element prefix
        if (false !== ($prefix = $this->getPrefix($name))) {
            // get unqualified name
            $name = $this->getLocalPart($name);
        } else {
            $prefix = '';
        }

        // loop thru attributes, expanding, and registering namespace declarations
        if ($attrs && is_array($attrs)) {
            foreach ($attrs as $k => $v) {
                // if ns declarations, add to class level array of valid namespaces
                if (preg_match('/^xmlns/', $k)) {
                    //$this->xdebug("$k: $v");
                    //$this->xdebug('ns_prefix: '.$this->getPrefix($k));
                    if (false !== ($ns_prefix = mb_substr(mb_strrchr($k, ':'), 1))) {
                        //$this->xdebug("Add namespace[$ns_prefix] = $v");
                        $this->namespaces[$ns_prefix] = $v;
                    } else {
                        $this->defaultNamespace[$pos] = $v;
                        if (!$this->getPrefixFromNamespace($v)) {
                            $this->namespaces['ns' . (count($this->namespaces) + 1)] = $v;
                        }
                    }
                    if ('http://www.w3.org/2001/XMLSchema' === $v || 'http://www.w3.org/1999/XMLSchema' === $v || 'http://www.w3.org/2000/10/XMLSchema' === $v) {
                        $this->XMLSchemaVersion  = $v;
                        $this->namespaces['xsi'] = $v . '-instance';
                    }
                }
            }
            foreach ($attrs as $k => $v) {
                // expand each attribute
                $k          = mb_strpos($k, ':') ? $this->expandQname($k) : $k;
                $v          = mb_strpos($v, ':') ? $this->expandQname($v) : $v;
                $eAttrs[$k] = $v;
            }
            $attrs = $eAttrs;
        } else {
            $attrs = [];
        }
        // find status, register data
        switch ($name) {
            case 'all':
                // (optional) compositor content for a complexType
            case 'choice':
            case 'group':
            case 'sequence':
                //$this->xdebug("compositor $name for currentComplexType: $this->currentComplexType and currentElement: $this->currentElement");

                $this->complexTypes[$this->currentComplexType]['compositor'] = $name;
                //if ($name == 'all' || $name == 'sequence') {
                //  $this->complexTypes[$this->currentComplexType]['phpType'] = 'struct';
                //}

                break;
            case 'attribute':
                // complexType attribute
                //$this->xdebug("parsing attribute $attrs[name] $attrs[ref] of value: ".$attrs['http://schemas.xmlsoap.org/wsdl/:arrayType']);
                $this->xdebug('parsing attribute:');
                $this->appendDebug($this->varDump($attrs));
                if (!isset($attrs['form'])) {
                    // TODO: handle globals
                    $attrs['form'] = $this->schemaInfo['attributeFormDefault'];
                }
                if (isset($attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'])) {
                    $v = $attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'];
                    if (!mb_strpos($v, ':')) {
                        // no namespace in arrayType attribute value...
                        if ($this->defaultNamespace[$pos]) {
                            // ...so use the default
                            $attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'] = $this->defaultNamespace[$pos] . ':' . $attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'];
                        }
                    }
                }
                if (isset($attrs['name'])) {
                    $this->attributes[$attrs['name']] = $attrs;
                    $aname                            = $attrs['name'];
                } elseif (isset($attrs['ref']) && 'http://schemas.xmlsoap.org/soap/encoding/:arrayType' === $attrs['ref']) {
                    $aname = '';
                    if (isset($attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'])) {
                        $aname = $attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'];
                    }
                } elseif (isset($attrs['ref'])) {
                    $aname                           = $attrs['ref'];
                    $this->attributes[$attrs['ref']] = $attrs;
                }

                if ($this->currentComplexType) {
                    // This should *always* be
                    $this->complexTypes[$this->currentComplexType]['attrs'][$aname] = $attrs;
                }
                // arrayType attribute
                if (isset($attrs['http://schemas.xmlsoap.org/wsdl/:arrayType']) || 'arrayType' === $this->getLocalPart($aname)) {
                    $this->complexTypes[$this->currentComplexType]['phpType'] = 'array';
                    $prefix                                                   = $this->getPrefix($aname);

                    $v                                                        = '';
                    if (isset($attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'])) {
                        $v = $attrs['http://schemas.xmlsoap.org/wsdl/:arrayType'];
                    }
                    if (mb_strpos($v, '[,]')) {
                        $this->complexTypes[$this->currentComplexType]['multidimensional'] = true;
                    }
                    $v = mb_substr($v, 0, mb_strpos($v, '[')); // clip the []
                    if (!mb_strpos($v, ':') && isset($this->typemap[$this->XMLSchemaVersion][$v])) {
                        $v = $this->XMLSchemaVersion . ':' . $v;
                    }
                    $this->complexTypes[$this->currentComplexType]['arrayType'] = $v;
                }

                break;
            case 'complexContent':
                // (optional) content for a complexType
                $this->xdebug("do nothing for element $name");

                break;
            case 'complexType':
                $this->complexTypeStack[] = $this->currentComplexType;
                if (isset($attrs['name'])) {
                    // TODO: what is the scope of named complexTypes that appear
                    //       nested within other c complexTypes?
                    $this->xdebug('processing named complexType ' . $attrs['name']);
                    //$this->currentElement = false;
                    $this->currentComplexType                                   = $attrs['name'];
                    $this->complexTypes[$this->currentComplexType]              = $attrs;
                    $this->complexTypes[$this->currentComplexType]['typeClass'] = 'complexType';
                    // This is for constructs like
                    //           <complexType name="ListOfString" base="soap:Array">
                    //                <sequence>
                    //                    <element name="string" type="xsd:string"
                    //                        minOccurs="0" maxOccurs="unbounded">
                    //                </sequence>
                    //            </complexType>
                    if (isset($attrs['base']) && preg_match('/:Array$/', $attrs['base'])) {
                        $this->xdebug('complexType is unusual array');
                        $this->complexTypes[$this->currentComplexType]['phpType'] = 'array';
                    } else {
                        $this->complexTypes[$this->currentComplexType]['phpType'] = 'struct';
                    }
                } else {
                    $name = $this->CreateTypeName($this->currentElement);
                    $this->xdebug('processing unnamed complexType for element ' . $this->currentElement . ' named ' . $name);
                    $this->currentComplexType = $name;
                    //$this->currentElement = false;
                    $this->complexTypes[$this->currentComplexType]              = $attrs;
                    $this->complexTypes[$this->currentComplexType]['typeClass'] = 'complexType';
                    // This is for constructs like
                    //           <complexType name="ListOfString" base="soap:Array">
                    //                <sequence>
                    //                    <element name="string" type="xsd:string"
                    //                        minOccurs="0" maxOccurs="unbounded">
                    //                </sequence>
                    //            </complexType>
                    if (isset($attrs['base']) && preg_match('/:Array$/', $attrs['base'])) {
                        $this->xdebug('complexType is unusual array');
                        $this->complexTypes[$this->currentComplexType]['phpType'] = 'array';
                    } else {
                        $this->complexTypes[$this->currentComplexType]['phpType'] = 'struct';
                    }
                }
                $this->complexTypes[$this->currentComplexType]['simpleContent'] = 'false';

                break;
            case 'element':
                $this->elementStack[] = $this->currentElement;
                if (!isset($attrs['form'])) {
                    if ($this->currentComplexType) {
                        $attrs['form'] = $this->schemaInfo['elementFormDefault'];
                    } else {
                        // global
                        $attrs['form'] = 'qualified';
                    }
                }
                if (isset($attrs['type'])) {
                    $this->xdebug('processing typed element ' . $attrs['name'] . ' of type ' . $attrs['type']);
                    if (!$this->getPrefix($attrs['type'])) {
                        if ($this->defaultNamespace[$pos]) {
                            $attrs['type'] = $this->defaultNamespace[$pos] . ':' . $attrs['type'];
                            $this->xdebug('used default namespace to make type ' . $attrs['type']);
                        }
                    }
                    // This is for constructs like
                    //           <complexType name="ListOfString" base="soap:Array">
                    //                <sequence>
                    //                    <element name="string" type="xsd:string"
                    //                        minOccurs="0" maxOccurs="unbounded">
                    //                </sequence>
                    //            </complexType>
                    if ($this->currentComplexType && 'array' === $this->complexTypes[$this->currentComplexType]['phpType']) {
                        $this->xdebug('arrayType for unusual array is ' . $attrs['type']);
                        $this->complexTypes[$this->currentComplexType]['arrayType'] = $attrs['type'];
                    }
                    $this->currentElement = $attrs['name'];
                    $ename                = $attrs['name'];
                } elseif (isset($attrs['ref'])) {
                    $this->xdebug('processing element as ref to ' . $attrs['ref']);
                    $this->currentElement = 'ref to ' . $attrs['ref'];
                    $ename                = $this->getLocalPart($attrs['ref']);
                } else {
                    $type = $this->CreateTypeName($this->currentComplexType . '_' . $attrs['name']);
                    $this->xdebug('processing untyped element ' . $attrs['name'] . ' type ' . $type);
                    $this->currentElement = $attrs['name'];
                    $attrs['type']        = $this->schemaTargetNamespace . ':' . $type;
                    $ename                = $attrs['name'];
                }
                if (isset($ename) && $this->currentComplexType) {
                    $this->xdebug("add element $ename to complexType $this->currentComplexType");
                    $this->complexTypes[$this->currentComplexType]['elements'][$ename] = $attrs;
                } elseif (!isset($attrs['ref'])) {
                    $this->xdebug("add element $ename to elements array");
                    $this->elements[$attrs['name']]              = $attrs;
                    $this->elements[$attrs['name']]['typeClass'] = 'element';
                }

                break;
            case 'enumeration':
                //  restriction value list member
                $this->xdebug('enumeration ' . $attrs['value']);
                if ($this->currentSimpleType) {
                    $this->simpleTypes[$this->currentSimpleType]['enumeration'][] = $attrs['value'];
                } elseif ($this->currentComplexType) {
                    $this->complexTypes[$this->currentComplexType]['enumeration'][] = $attrs['value'];
                }

                break;
            case 'extension':
                // simpleContent or complexContent type extension
                $this->xdebug('extension ' . $attrs['base']);
                if ($this->currentComplexType) {
                    $ns = $this->getPrefix($attrs['base']);
                    if ('' === $ns) {
                        $this->complexTypes[$this->currentComplexType]['extensionBase'] = $this->schemaTargetNamespace . ':' . $attrs['base'];
                    } else {
                        $this->complexTypes[$this->currentComplexType]['extensionBase'] = $attrs['base'];
                    }
                } else {
                    $this->xdebug('no current complexType to set extensionBase');
                }

                break;
            case 'import':
                if (isset($attrs['schemaLocation'])) {
                    $this->xdebug('import namespace ' . $attrs['namespace'] . ' from ' . $attrs['schemaLocation']);
                    $this->imports[$attrs['namespace']][] = ['location' => $attrs['schemaLocation'], 'loaded' => false];
                } else {
                    $this->xdebug('import namespace ' . $attrs['namespace']);
                    $this->imports[$attrs['namespace']][] = ['location' => '', 'loaded' => true];
                    if (!$this->getPrefixFromNamespace($attrs['namespace'])) {
                        $this->namespaces['ns' . (count($this->namespaces) + 1)] = $attrs['namespace'];
                    }
                }

                break;
            case 'include':
                if (isset($attrs['schemaLocation'])) {
                    $this->xdebug('include into namespace ' . $this->schemaTargetNamespace . ' from ' . $attrs['schemaLocation']);
                    $this->imports[$this->schemaTargetNamespace][] = ['location' => $attrs['schemaLocation'], 'loaded' => false];
                } else {
                    $this->xdebug('ignoring invalid XML Schema construct: include without schemaLocation attribute');
                }

                break;
            case 'list':
                // simpleType value list
                $this->xdebug("do nothing for element $name");

                break;
            case 'restriction':
                // simpleType, simpleContent or complexContent value restriction
                $this->xdebug('restriction ' . $attrs['base']);
                if ($this->currentSimpleType) {
                    $this->simpleTypes[$this->currentSimpleType]['type'] = $attrs['base'];
                } elseif ($this->currentComplexType) {
                    $this->complexTypes[$this->currentComplexType]['restrictionBase'] = $attrs['base'];
                    if (':Array' === mb_strstr($attrs['base'], ':')) {
                        $this->complexTypes[$this->currentComplexType]['phpType'] = 'array';
                    }
                }

                break;
            case 'schema':
                $this->schemaInfo                  = $attrs;
                $this->schemaInfo['schemaVersion'] = $this->getNamespaceFromPrefix($prefix);
                if (isset($attrs['targetNamespace'])) {
                    $this->schemaTargetNamespace = $attrs['targetNamespace'];
                }
                if (!isset($attrs['elementFormDefault'])) {
                    $this->schemaInfo['elementFormDefault'] = 'unqualified';
                }
                if (!isset($attrs['attributeFormDefault'])) {
                    $this->schemaInfo['attributeFormDefault'] = 'unqualified';
                }

                break;
            case 'simpleContent':
                // (optional) content for a complexType
                if ($this->currentComplexType) {
                    // This should *always* be
                    $this->complexTypes[$this->currentComplexType]['simpleContent'] = 'true';
                } else {
                    $this->xdebug("do nothing for element $name because there is no current complexType");
                }

                break;
            case 'simpleType':
                $this->simpleTypeStack[] = $this->currentSimpleType;
                if (isset($attrs['name'])) {
                    $this->xdebug('processing simpleType for name ' . $attrs['name']);
                    $this->currentSimpleType                        = $attrs['name'];
                    $this->simpleTypes[$attrs['name']]              = $attrs;
                    $this->simpleTypes[$attrs['name']]['typeClass'] = 'simpleType';
                    $this->simpleTypes[$attrs['name']]['phpType']   = 'scalar';
                } else {
                    $name = $this->CreateTypeName($this->currentComplexType . '_' . $this->currentElement);
                    $this->xdebug('processing unnamed simpleType for element ' . $this->currentElement . ' named ' . $name);
                    $this->currentSimpleType = $name;
                    //$this->currentElement = false;
                    $this->simpleTypes[$this->currentSimpleType]            = $attrs;
                    $this->simpleTypes[$this->currentSimpleType]['phpType'] = 'scalar';
                }

                break;
            case 'union':
                // simpleType type list
                $this->xdebug("do nothing for element $name");

                break;
            default:
                $this->xdebug("do not have any logic to process element $name");
        }
    }

    /**
     * End-element handler
     *
     * @param string $parser XML parser object
     * @param string $name   element name
     */
    private function schemaEndElement($parser, $name)
    private function schemaEndElement(/** @scrutinizer ignore-unused */ $parser, $name)
    {
        // bring depth down a notch
        $this->depth--;
        // position of current element is equal to the last value left in depth_array for my depth
        if (isset($this->depth_array[$this->depth])) {
            $pos = $this->depth_array[$this->depth];

        }
        // get element prefix
        if (false !== ($prefix = $this->getPrefix($name))) {

            // get unqualified name
            $name = $this->getLocalPart($name);
        } else {
            $prefix = '';
        }
        // move on...
        if ('complexType' === $name) {
            $this->xdebug('done processing complexType ' . ($this->currentComplexType ?: '(unknown)'));
            $this->xdebug($this->varDump($this->complexTypes[$this->currentComplexType]));
            $this->currentComplexType = array_pop($this->complexTypeStack);
            //$this->currentElement = false;
        }
        if ('element' === $name) {
            $this->xdebug('done processing element ' . ($this->currentElement ?: '(unknown)'));
            $this->currentElement = array_pop($this->elementStack);
        }
        if ('simpleType' === $name) {
            $this->xdebug('done processing simpleType ' . ($this->currentSimpleType ?: '(unknown)'));
            $this->xdebug($this->varDump($this->simpleTypes[$this->currentSimpleType]));
            $this->currentSimpleType = array_pop($this->simpleTypeStack);
        }
    }

    /**
     * Element content handler
     *
     * @param string $parser XML parser object
     * @param string $data   element content
     */
    private function schemaCharacterData($parser, $data)
    private function schemaCharacterData(/** @scrutinizer ignore-unused */ $parser, $data)
    {
        $pos                          = $this->depth_array[$this->depth - 1];
        $this->message[$pos]['cdata'] .= $data;
    }

    /**
     * Serialize the schema
     */
    public function serializeSchema()
    {
        $schemaPrefix = $this->getPrefixFromNamespace($this->XMLSchemaVersion);
        $xml          = '';
        // imports
        if ($this->imports && is_array($this->imports)) {

            foreach ($this->imports as $ns => $list) {
                foreach ($list as $ii) {
                    if ('' !== $ii['location']) {
                        $xml .= " <$schemaPrefix:import location=\"" . $ii['location'] . '" namespace="' . $ns . "\">\n";
                    } else {
                        $xml .= " <$schemaPrefix:import namespace=\"" . $ns . "\">\n";
                    }
                }
            }
        }
        // complex types
        foreach ($this->complexTypes as $typeName => $attrs) {
            $contentStr = '';
            // serialize child elements
            if (isset($attrs['elements']) && (count($attrs['elements']) > 0)) {
                foreach ($attrs['elements'] as $element => $eParts) {
                    if (isset($eParts['ref'])) {
                        $contentStr .= "   <$schemaPrefix:element ref=\"$element\">\n";
                    } else {
                        $contentStr .= "   <$schemaPrefix:element name=\"$element\" type=\"" . $this->contractQName($eParts['type']) . '"';
                        foreach ($eParts as $aName => $aValue) {
                            // handle, e.g., abstract, default, form, minOccurs, maxOccurs, nillable
                            if ('name' !== $aName && 'type' !== $aName) {
                                $contentStr .= " $aName=\"$aValue\"";
                            }
                        }
                        $contentStr .= ">\n";
                    }
                }
                // compositor wraps elements
                if (isset($attrs['compositor']) && ('' !== $attrs['compositor'])) {
                    $contentStr = "  <$schemaPrefix:$attrs[compositor]>\n" . $contentStr . "  </$schemaPrefix:$attrs[compositor]>\n";
                }
            }
            // attributes
            if (isset($attrs['attrs']) && (count($attrs['attrs']) >= 1)) {
                foreach ($attrs['attrs'] as $attr => $aParts) {
                    $contentStr .= "    <$schemaPrefix:attribute";
                    foreach ($aParts as $a => $v) {
                        if ('ref' === $a || 'type' === $a) {
                            $contentStr .= " $a=\"" . $this->contractQName($v) . '"';
                        } elseif ('http://schemas.xmlsoap.org/wsdl/:arrayType' === $a) {
                            $this->usedNamespaces['wsdl'] = $this->namespaces['wsdl'];
                            $contentStr                   .= ' Wsdl:arrayType="' . $this->contractQName($v) . '"';
                        } else {
                            $contentStr .= " $a=\"$v\"";
                        }
                    }
                    $contentStr .= ">\n";
                }
            }
            // if restriction
            if (isset($attrs['restrictionBase']) && '' !== $attrs['restrictionBase']) {
                $contentStr = "   <$schemaPrefix:restriction base=\"" . $this->contractQName($attrs['restrictionBase']) . "\">\n" . $contentStr . "   </$schemaPrefix:restriction>\n";
                // complex or simple content
                if ((isset($attrs['elements']) && count($attrs['elements']) > 0) || (isset($attrs['attrs']) && count($attrs['attrs']) > 0)) {
                    $contentStr = "  <$schemaPrefix:complexContent>\n" . $contentStr . "  </$schemaPrefix:complexContent>\n";
                }
            }
            // finalize complex type
            if ('' !== $contentStr) {
                $contentStr = " <$schemaPrefix:complexType name=\"$typeName\">\n" . $contentStr . " </$schemaPrefix:complexType>\n";
            } else {
                $contentStr = " <$schemaPrefix:complexType name=\"$typeName\">\n";
            }
            $xml .= $contentStr;
        }
        // simple types
        if (isset($this->simpleTypes) && count($this->simpleTypes) > 0) {
            foreach ($this->simpleTypes as $typeName => $eParts) {
                $xml .= " <$schemaPrefix:simpleType name=\"$typeName\">\n  <$schemaPrefix:restriction base=\"" . $this->contractQName($eParts['type']) . "\">\n";
                if (isset($eParts['enumeration'])) {
                    foreach ($eParts['enumeration'] as $e) {
                        $xml .= "  <$schemaPrefix:enumeration value=\"$e\">\n";
                    }
                }
                $xml .= "  </$schemaPrefix:restriction>\n </$schemaPrefix:simpleType>";
            }
        }
        // elements
        if (isset($this->elements) && count($this->elements) > 0) {
            foreach ($this->elements as $element => $eParts) {
                $xml .= " <$schemaPrefix:element name=\"$element\" type=\"" . $this->contractQName($eParts['type']) . "\">\n";
            }
        }
        // attributes
        if (isset($this->attributes) && count($this->attributes) > 0) {
            foreach ($this->attributes as $attr => $aParts) {
                $xml .= " <$schemaPrefix:attribute name=\"$attr\" type=\"" . $this->contractQName($aParts['type']) . "\"\n>";
            }
        }
        // finish 'er up
        $attr = '';
        foreach ($this->schemaInfo as $k => $v) {
            if ('elementFormDefault' === $k || 'attributeFormDefault' === $k) {
                $attr .= " $k=\"$v\"";
            }
        }
        $el = "<$schemaPrefix:schema$attr targetNamespace=\"$this->schemaTargetNamespace\"\n";
        foreach (array_diff($this->usedNamespaces, $this->enclosingNamespaces) as $nsp => $ns) {
        foreach (array_diff($this->usedNamespaces, /** @scrutinizer ignore-type */ $this->enclosingNamespaces) as $nsp => $ns) {
            $el .= " xmlns:$nsp=\"$ns\"";
        }
        $xml = $el . ">\n" . $xml . "</$schemaPrefix:schema>\n";

        return $xml;
    }

    /**
     * Adds debug data to the clas level debug string
     *
     * @param string $string debug data
     */
    private function xdebug($string)
    {
        $this->debug('<' . $this->schemaTargetNamespace . '> ' . $string);
    }

    /**
     * Get the PHP type of a user defined type in the schema
     * PHP type is kind of a misnomer since it actually returns 'struct' for assoc. arrays
     * returns false if no type exists, or not w/ the given namespace
     * else returns a string that is either a native php type, or 'struct'
     *
     * @param  string $type name of defined type
     * @param  string $ns   namespace of type
     * @return mixed
     * @deprecated
     */
    public function getPHPType($type, $ns)
    {
        if (isset($this->typemap[$ns][$type])) {
            //print "found type '$type' and ns $ns in typemap<br>";
            return $this->typemap[$ns][$type];
        }

        if (isset($this->complexTypes[$type])) {
            //print "getting type '$type' and ns $ns from complexTypes array<br>";
            return $this->complexTypes[$type]['phpType'];
        }

        return false;
    }

    /**
     * Returns an associative array of information about a given type
     * Returns false if no type exists by the given name
     *
     *   For a complexType typeDef = array(
     *   'restrictionBase' => '',
     *   'phpType' => '',
     *   'compositor' => '(sequence|all)',
     *   'elements' => array(), // refs to elements array
     *   'attrs' => array() // refs to attributes array
     *   ... and so on (see addComplexType)
     *   )
     *
     *   For simpleType or element, the array has different keys.
     *
     * @param  string $type
     * @return mixed
     * @see    addComplexType
     * @see    addSimpleType
     * @see    addElement
     */
    public function getTypeDef($type)
    {
        $typeDef = [];
        //$this->debug("in getTypeDef for type $type");
        if ('^' === mb_substr($type, -1)) {
            $is_element = 1;
            $type       = mb_substr($type, 0, -1);
        } else {
            $is_element = 0;
        }

        if ((!$is_element) && isset($this->complexTypes[$type])) {
            $this->xdebug("in getTypeDef, found complexType $type");

            return $this->complexTypes[$type];
        }

        if ((!$is_element) && isset($this->simpleTypes[$type])) {
            $this->xdebug("in getTypeDef, found simpleType $type");
            if (!isset($this->simpleTypes[$type]['phpType'])) {
                // get info for type to tack onto the simple type
                // TODO: can this ever really apply (i.e. what is a simpleType really?)
                $uqType = mb_substr($this->simpleTypes[$type]['type'], mb_strrpos($this->simpleTypes[$type]['type'], ':') + 1);
                $ns     = mb_substr($this->simpleTypes[$type]['type'], 0, mb_strrpos($this->simpleTypes[$type]['type'], ':'));

                $etype  = $this->getTypeDef($uqType);
                if ($etype) {
                    $this->xdebug("in getTypeDef, found type for simpleType $type:");
                    $this->xdebug($this->varDump($etype));
                    if (isset($etype['phpType'])) {
                        $this->simpleTypes[$type]['phpType'] = $etype['phpType'];
                    }
                    if (isset($etype['elements'])) {
                        $this->simpleTypes[$type]['elements'] = $etype['elements'];
                    }
                }
            }

            return $this->simpleTypes[$type];
        } elseif (isset($this->elements[$type])) {
            $this->xdebug("in getTypeDef, found element $type");
            if (!isset($this->elements[$type]['phpType'])) {
                // get info for type to tack onto the element
                $uqType = mb_substr($this->elements[$type]['type'], mb_strrpos($this->elements[$type]['type'], ':') + 1);
                $ns     = mb_substr($this->elements[$type]['type'], 0, mb_strrpos($this->elements[$type]['type'], ':'));
                $etype  = $this->getTypeDef($uqType);
                if ($etype) {
                    $this->xdebug("in getTypeDef, found type for element $type:");
                    $this->xdebug($this->varDump($etype));
                    if (isset($etype['phpType'])) {
                        $this->elements[$type]['phpType'] = $etype['phpType'];
                    }
                    if (isset($etype['elements'])) {
                        $this->elements[$type]['elements'] = $etype['elements'];
                    }
                    if (isset($etype['extensionBase'])) {
                        $this->elements[$type]['extensionBase'] = $etype['extensionBase'];
                    }
                } elseif ('http://www.w3.org/2001/XMLSchema' === $ns) {
                    $this->xdebug("in getTypeDef, element $type is an XSD type");
                    $this->elements[$type]['phpType'] = 'scalar';
                }
            }

            return $this->elements[$type];
        } elseif (isset($this->attributes[$type])) {
            $this->xdebug("in getTypeDef, found attribute $type");

            return $this->attributes[$type];
        } elseif (preg_match('/_ContainedType$/', $type)) {
            $this->xdebug("in getTypeDef, have an untyped element $type");
            $typeDef['typeClass'] = 'simpleType';
            $typeDef['phpType']   = 'scalar';
            $typeDef['type']      = 'http://www.w3.org/2001/XMLSchema:string';

            return $typeDef;
        }
        $this->xdebug("in getTypeDef, did not find $type");

        return false;
    }

    /**
     * Returns a sample serialization of a given type, or false if no type by the given name
     *
     * @param  string $type name of type
     * @return mixed
     * @deprecated
     */
    public function serializeTypeDef($type)
    {
        $str = '';
        //print "in sTD() for type $type<br>";
        if (false !== ($typeDef = $this->getTypeDef($type))) {
            $str .= '<' . $type;
            if (is_array($typeDef['attrs'])) {
                foreach ($typeDef['attrs'] as $attName => $data) {
                    $str .= " $attName=\"{type = " . $data['type'] . '}"';
                }
            }
            $str .= ' xmlns="' . $this->schema['targetNamespace'] . '"';
            if (is_array($typeDef['elements']) && count($typeDef['elements']) > 0) {
                $str .= '>';
                foreach ($typeDef['elements'] as $element => $eData) {
                    $str .= $this->serializeTypeDef($element);
                    $str .= /** @scrutinizer ignore-deprecated */ $this->serializeTypeDef($element);
                }
                $str .= "</$type>";
            } elseif ('element' === $typeDef['typeClass']) {
                $str .= "></$type>";
            } else {
                $str .= '>';
            }

            return $str;
        }

        return false;
    }

    /**
     * Returns HTML form elements that allow a user
     * to enter values for creating an instance of the given type.
     *
     * @param  string $name name for type instance
     * @param  string $type name of type
     * @return string
     * @deprecated
     */
    public function typeToForm($name, $type)
    {
        $buffer = '';
        // get typedef
        if (false !== ($typeDef = $this->getTypeDef($type))) {
            // if struct
            if ('struct' === $typeDef['phpType']) {
                $buffer .= '<table>';
                foreach ($typeDef['elements'] as $child => $childDef) {
                    $buffer .= "
                    <tr><td align='right'>$childDef[name] (type: " . $this->getLocalPart($childDef['type']) . "):</td>
                    <td><input type='text' name='parameters[" . $name . "][$childDef[name]]'></td></tr>";
                }
                $buffer .= '</table>';
                // if array
            } elseif ('array' === $typeDef['phpType']) {
                $buffer .= '<table>';
                for ($i = 0; $i < 3; ++$i) {
                    $buffer .= "
                    <tr><td align='right'>array item (type: $typeDef[arrayType]):</td>
                    <td><input type='text' name='parameters[" . $name . "][]'></td></tr>";
                }
                $buffer .= '</table>';
                // if scalar
            } else {
                $buffer .= "<input type='text' name='parameters[$name]'>";
            }
        } else {
            $buffer .= "<input type='text' name='parameters[$name]'>";
        }

        return $buffer;
    }

    /**
     * Adds a complex type to the schema
     *
     * Example: array
     *
     * addType(
     *   'ArrayOfstring',
     *   'complexType',
     *   'array',
     *   '',
     *   'SOAP-ENC:Array',
     *    array('ref'=>'SOAP-ENC:arrayType','Wsdl:arrayType'=>'string[]'),
     *   'xsd:string'
     * );
     *
     * Example: PHP associative array ( SOAP Struct )
     *
     * addType(
     *   'SOAPStruct',
     *   'complexType',
     *   'struct',
     *   'all',
     *   array('myVar'=> array('name'=>'myVar','type'=>'string')
     * );
     *
     * @param mixed  $name
     * @param mixed  $typeClass
     * @param mixed  $phpType
     * @param string $compositor      (all|sequence|choice)
     * @param string $restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
     * @param array  $elements        = array ( name = array(name=>'',type=>'') )
     * @param array  $attrs           = array(
     *                                array(
     *                                'ref' => "http://schemas.xmlsoap.org/soap/encoding/:arrayType",
     *                                "http://schemas.xmlsoap.org/wsdl/:arrayType" => "string[]"
     *                                )
     *                                )
     * @param mixed  $arrayType
     * @see      getTypeDef
     */
    public function addComplexType(
        $name,
        $typeClass = 'complexType',
        $phpType = 'array',
        $compositor = '',
        $restrictionBase = '',
        $elements = [],
        $attrs = [],
        $arrayType = '')
    {
        $this->complexTypes[$name] = [
            'name'            => $name,
            'typeClass'       => $typeClass,
            'phpType'         => $phpType,
            'compositor'      => $compositor,
            'restrictionBase' => $restrictionBase,
            'elements'        => $elements,
            'attrs'           => $attrs,
            'arrayType'       => $arrayType,
        ];

        $this->xdebug("addComplexType $name:");
        $this->appendDebug($this->varDump($this->complexTypes[$name]));
    }

    /**
     * adds a simple type to the schema
     *
     * @param string $name
     * @param string $restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
     * @param string $typeClass       (should always be simpleType)
     * @param string $phpType         (should always be scalar)
     * @param array  $enumeration     array of values
     * @see    nusoap_xmlschema
     * @see    getTypeDef
     */
    public function addSimpleType(
        $name,
        $restrictionBase = '',
        $typeClass = 'simpleType',
        $phpType = 'scalar',
        $enumeration = [])
    {
        $this->simpleTypes[$name] = [
            'name'        => $name,
            'typeClass'   => $typeClass,
            'phpType'     => $phpType,
            'type'        => $restrictionBase,
            'enumeration' => $enumeration,
        ];

        $this->xdebug("addSimpleType $name:");
        $this->appendDebug($this->varDump($this->simpleTypes[$name]));
    }

    /**
     * adds an element to the schema
     *
     * @param array $attrs attributes that must include name and type
     * @see    nusoap_xmlschema
     */
    public function addElement($attrs)
    {
        if (!$this->getPrefix($attrs['type'])) {
            $attrs['type'] = $this->schemaTargetNamespace . ':' . $attrs['type'];
        }
        $this->elements[$attrs['name']]              = $attrs;
        $this->elements[$attrs['name']]['typeClass'] = 'element';

        $this->xdebug('addElement ' . $attrs['name']);
        $this->appendDebug($this->varDump($this->elements[$attrs['name']]));
    }
}

/**
 * Backward compatibility
 */
class XMLSchema extends Nusoap_xmlschema
{
}

/**
 * For creating serializable abstractions of native PHP types.  This class
 * allows element name/namespace, XSD type, and XML attributes to be
 * associated with a value.  This is extremely useful when WSDL is not
 * used, but is also useful when WSDL is used with polymorphic types, including
 * xsd:anyType and user-defined types.
 *
 * @author   Dietrich Ayala <[email protected]>
 */
class Soapval extends Nusoap_base
{
    /**
     * The XML element name
     *
     * @var string
     */
    private $name;
    /**
     * The XML type name (string or false)
     *
     * @var mixed
     */
    public $type;
    /**
     * The PHP value
     *
     * @var mixed
     */
    public $value;
    /**
     * The XML element namespace (string or false)
     *
     * @var mixed
     */
    private $element_ns;
    /**
     * The XML type namespace (string or false)
     *
     * @var mixed
     */
    public $type_ns;
    /**
     * The XML element attributes (array or false)
     *
     * @var mixed
     */
    public $attributes;

    /**
     * constructor
     *
     * @param string $name       optional name
     * @param mixed  $type       optional type name
     * @param mixed  $value      optional value
     * @param mixed  $element_ns optional namespace of value
     * @param mixed  $type_ns    optional namespace of type
     * @param mixed  $attributes associative array of attributes to add to element serialization
     */
    public function __construct(
        $name = 'soapval',
        $type = false,
        $value = -1,
        $element_ns = false,
        $type_ns = false,
        $attributes = false)
    {
        parent::__construct();
        $this->name       = $name;
        $this->type       = $type;
        $this->value      = $value;
        $this->element_ns = $element_ns;
        $this->type_ns    = $type_ns;
        $this->attributes = $attributes;
    }

    /**
     * return serialized value
     *
     * @param  string $use The WSDL use value (encoded|literal)
     * @return string XML data
     */
    public function serialize($use = 'encoded')
    {
        return $this->serialize_val($this->value, $this->name, $this->type, $this->element_ns, $this->type_ns, $this->attributes, $use, true);
    }

    /**
     * decodes a soapval object into a PHP native type
     *
     * @return mixed
     */
    public function decode()
    {
        return $this->value;
    }
}

/**
 * transport class for sending/receiving data via HTTP and HTTPS
 * NOTE: PHP must be compiled with the CURL extension for HTTPS support
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Soap_transport_http extends Nusoap_base
{
    public $url                  = '';
    public $uri                  = '';
    public $digest_uri           = '';
    public $scheme               = '';
    public $host                 = '';
    public $port                 = '';
    public $path                 = '';
    public $request_method       = 'POST';
    public $protocol_version     = '1.0';
    public $encoding             = '';
    public $outgoing_headers     = [];
    public $incoming_headers     = [];
    public $incoming_cookies     = [];
    public $outgoing_payload     = '';
    public $incoming_payload     = '';
    public $response_status_line;    // HTTP response status line
    public $useSOAPAction        = true;
    public $persistentConnection = false;
    public $ch                   = false;    // cURL handle
    public $ch_options           = [];    // cURL custom options
    public $use_curl             = false;        // force cURL use
    public $proxy;            // proxy information (associative array)
    public $username             = '';
    public $password             = '';
    public $authtype             = '';
    public $digestRequest        = [];
    public $certRequest          = [];
    // keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, certpassword (optional), verifypeer (optional), verifyhost (optional)
    // cainfofile: certificate authority file, e.g. '$pathToPemFiles/rootca.pem'
    // sslcertfile: SSL certificate file, e.g. '$pathToPemFiles/mycert.pem'
    // sslkeyfile: SSL key file, e.g. '$pathToPemFiles/mykey.pem'
    // passphrase: SSL key password/passphrase
    // certpassword: SSL certificate password
    // verifypeer: default is 1
    // verifyhost: default is 1

    /**
     * constructor
     *
     * @param string $url          The URL to which to connect
     * @param array  $curl_options User-specified cURL options
     * @param bool   $use_curl     Whether to try to force cURL use
     */
    public function __construct($url, $curl_options = null, $use_curl = false)
    {
        parent::__construct();
        $this->debug("ctor url=$url use_curl=$use_curl curl_options:");
        $this->appendDebug($this->varDump($curl_options));
        $this->setURL($url);
        if (is_array($curl_options)) {
            $this->ch_options = $curl_options;
        }
        $this->use_curl = $use_curl;
        preg_match('/\$Revisio' . 'n: ([^ ]+)/', $this->revision, $rev);
        $this->setHeader('User-Agent', $this->title . '/' . $this->version . ' (' . $rev[1] . ')');
    }

    /**
     * sets a cURL option
     *
     * @param mixed $option The cURL option (always integer?)
     * @param mixed $value  The cURL option value
     */
    private function setCurlOption($option, $value)
    {
        $this->debug("setCurlOption option=$option, value=");
        $this->appendDebug($this->varDump($value));
        curl_setopt($this->ch, $option, $value);
        curl_setopt(/** @scrutinizer ignore-type */ $this->ch, $option, $value);
    }

    /**
     * sets an HTTP header
     *
     * @param string $name  The name of the header
     * @param string $value The value of the header
     */
    private function setHeader($name, $value)
    {
        $this->outgoing_headers[$name] = $value;
        $this->debug("set header $name: $value");
    }

    /**
     * unsets an HTTP header
     *
     * @param string $name The name of the header
     */
    private function unsetHeader($name)
    {
        if (isset($this->outgoing_headers[$name])) {
            $this->debug("unset header $name");
            unset($this->outgoing_headers[$name]);
        }
    }

    /**
     * sets the URL to which to connect
     *
     * @param string $url The URL to which to connect
     */
    private function setURL($url)
    {
        $this->url = $url;

        $u = parse_url($url);
        foreach ($u as $k => $v) {
            $this->debug("parsed URL $k = $v");
            $this->$k = $v;
        }

        // add any GET params to path
        if (isset($u['query']) && '' !== $u['query']) {
            $this->path .= '?' . $u['query'];
        }

        // set default port
        if (!isset($u['port'])) {
            $this->port = 80;
            if ('https' === $u['scheme']) {
                $this->port = 443;
            }
        }

        $this->uri        = $this->path;
        $this->digest_uri = $this->uri;

        // build headers
        if (!isset($u['port'])) {
            $this->setHeader('Host', $this->host);
        } else {
            $this->setHeader('Host', $this->host . ':' . $this->port);
        }

        if (isset($u['user']) && '' !== $u['user']) {
            $this->setCredentials(urldecode($u['user']), isset($u['pass']) ? urldecode($u['pass']) : '');
        }
    }

    /**
     * gets the I/O method to use
     *
     * @return string I/O method to use (socket|curl|unknown)
     */
    private function io_method()
    {
        if ($this->use_curl || ('https' === $this->scheme) || ('http' === $this->scheme && 'ntlm' === $this->authtype) || ('http' === $this->scheme && is_array($this->proxy) && 'ntlm' === $this->proxy['authtype'])) {
            return 'curl';
        }
        if (('http' === $this->scheme || 'ssl' === $this->scheme) && 'ntlm' !== $this->authtype && (!is_array($this->proxy) || 'ntlm' !== $this->proxy['authtype'])) {
            return 'socket';
        }

        return 'unknown';
    }

    /**
     * establish an HTTP connection
     *
     * @param int $connection_timeout set connection timeout in seconds
     * @param int $response_timeout   set response timeout in seconds
     * @return bool    true if connected, false if not
     */
    private function connect($connection_timeout = 0, $response_timeout = 30)
    {
        // For PHP 4.3 with OpenSSL, change https scheme to ssl, then treat like
        // "regular" socket.
        // TODO: disabled for now because OpenSSL must be *compiled* in (not just
        //       loaded), and until PHP5 stream_get_wrappers is not available.
        //      if ($this->scheme == 'https') {
        //          if (version_compare(PHP_VERSION, '4.3.0') >= 0) {
        //              if (extension_loaded('openssl')) {
        //                  $this->scheme = 'ssl';
        //                  $this->debug('Using SSL over OpenSSL');
        //              }
        //          }
        //      }
        $this->debug("connect connection_timeout $connection_timeout, response_timeout $response_timeout, scheme $this->scheme, host $this->host, port $this->port");
        if ('socket' === $this->io_method()) {
            if (!is_array($this->proxy)) {
                $host = $this->host;
                $port = $this->port;

            } else {
                $host = $this->proxy['host'];
                $port = $this->proxy['port'];
            }

            // use persistent connection
            if ($this->persistentConnection && isset($this->fp) && is_resource($this->fp)) {
                if (!feof($this->fp)) {
                    $this->debug('Re-use persistent connection');

                    return true;
                }
                fclose($this->fp);
                $this->debug('Closed persistent connection at EOF');
            }

            // munge host if using OpenSSL
            if ('ssl' === $this->scheme) {
                $host = 'ssl://' . $host;
            }
            $this->debug('calling fsockopen with host ' . $host . ' connection_timeout ' . $connection_timeout);

            // open socket
            if ($connection_timeout > 0) {
                $this->fp = @fsockopen($host, $this->port, $this->errno, $this->error_str, $connection_timeout);
                $this->fp = @fsockopen($host, /** @scrutinizer ignore-type */ $this->port, $this->errno, $this->error_str, $connection_timeout);
            } else {
                $this->fp = @fsockopen($host, $this->port, $this->errno, $this->error_str);
            }

            // test pointer
            if (!$this->fp) {
                $msg = 'Couldn\'t open socket connection to server ' . $this->url;
                if ($this->errno) {
                    $msg .= ', Error (' . $this->errno . '): ' . $this->error_str;
                } else {
                    $msg .= ' prior to connect().  This is often a problem looking up the host name.';
                }
                $this->debug($msg);
                $this->setError($msg);

                return false;
            }

            // set response timeout
            $this->debug('set response timeout to ' . $response_timeout);
            stream_set_timeout($this->fp, $response_timeout);

            $this->debug('socket connected');

            return true;
        }

        if ('curl' === $this->io_method()) {
            if (!extension_loaded('curl')) {
                //          $this->setError('cURL Extension, or OpenSSL extension w/ PHP version >= 4.3 is required for HTTPS');
                $this->setError('The PHP cURL Extension is required for HTTPS or NLTM.  You will need to re-build or update your PHP to include cURL or change php.ini to load the PHP cURL extension.');

                return false;
            }
            // Avoid warnings when PHP does not have these options
            $CURLOPT_CONNECTIONTIMEOUT = 78;
            if (defined('CURLOPT_CONNECTIONTIMEOUT')) {
                $CURLOPT_CONNECTIONTIMEOUT = CURLOPT_CONNECTIONTIMEOUT;

            }
            $CURLOPT_HTTPAUTH = 107;
            if (defined('CURLOPT_HTTPAUTH')) {
                $CURLOPT_HTTPAUTH = CURLOPT_HTTPAUTH;
            }
            $CURLOPT_PROXYAUTH = 111;
            if (defined('CURLOPT_PROXYAUTH')) {
                $CURLOPT_PROXYAUTH = CURLOPT_PROXYAUTH;
            }
            $CURLAUTH_BASIC = 1;
            if (defined('CURLAUTH_BASIC')) {
                $CURLAUTH_BASIC = CURLAUTH_BASIC;
            }
            $CURLAUTH_DIGEST = 2;
            if (defined('CURLAUTH_DIGEST')) {
                $CURLAUTH_DIGEST = CURLAUTH_DIGEST;
            }
            $CURLAUTH_NTLM = 8;
            if (defined('CURLAUTH_NTLM')) {
                $CURLAUTH_NTLM = CURLAUTH_NTLM;
            }

            $this->debug('connect using cURL');
            // init CURL
            $this->ch = curl_init();
            // set url
            $hostURL = ('' !== $this->port) ? "$this->scheme://$this->host:$this->port" : "$this->scheme://$this->host";
            // add path
            $hostURL .= $this->path;
            $this->setCurlOption(CURLOPT_URL, $hostURL);
            // follow location headers (re-directs)
            if (ini_get('open_basedir')) {
                $this->debug('open_basedir set, so do not set CURLOPT_FOLLOWLOCATION');
                $this->debug('open_basedir = ');
                $this->appendDebug($this->varDump(ini_get('open_basedir')));
            } else {
                $this->setCurlOption(CURLOPT_FOLLOWLOCATION, 1);
            }
            // ask for headers in the response output
            $this->setCurlOption(CURLOPT_HEADER, 1);
            // ask for the response output as the return value
            $this->setCurlOption(CURLOPT_RETURNTRANSFER, 1);
            // encode
            // We manage this ourselves through headers and encoding
            //      if (function_exists('gzuncompress')) {
            //          $this->setCurlOption(CURLOPT_ENCODING, 'deflate');
            //      }
            // persistent connection
            if ($this->persistentConnection) {
                // I believe the following comment is now bogus, having applied to
                // the code when it used CURLOPT_CUSTOMREQUEST to send the request.
                // The way we send data, we cannot use persistent connections, since
                // there will be some "junk" at the end of our request.
                //$this->setCurlOption(CURL_HTTP_VERSION_1_1, true);
                $this->persistentConnection = false;
                $this->setHeader('Connection', 'close');
            }
            // set timeouts
            if (0 != $connection_timeout) {
                $this->setCurlOption($CURLOPT_CONNECTIONTIMEOUT, $connection_timeout);
            }
            if (0 != $response_timeout) {
                $this->setCurlOption(CURLOPT_TIMEOUT, $response_timeout);
            }

            if ('https' === $this->scheme) {
                $this->debug('set cURL SSL verify options');
                // recent versions of cURL turn on peer/host checking by default,
                // while PHP binaries are not compiled with a default location for the
                // CA cert bundle, so disable peer/host checking.
                //$this->setCurlOption(CURLOPT_CAINFO, 'f:\php-4.3.2-win32\extensions\curl-ca-bundle.crt');
                $this->setCurlOption(CURLOPT_SSL_VERIFYPEER, 0);
                $this->setCurlOption(CURLOPT_SSL_VERIFYHOST, 0);

                // support client certificates (thanks Tobias Boes, Doug Anarino, Eryan Ariobowo)
                if ('certificate' === $this->authtype) {
                    $this->debug('set cURL certificate options');
                    if (isset($this->certRequest['cainfofile'])) {
                        $this->setCurlOption(CURLOPT_CAINFO, $this->certRequest['cainfofile']);
                    }
                    if (isset($this->certRequest['verifypeer'])) {
                        $this->setCurlOption(CURLOPT_SSL_VERIFYPEER, $this->certRequest['verifypeer']);
                    } else {
                        $this->setCurlOption(CURLOPT_SSL_VERIFYPEER, 1);
                    }
                    if (isset($this->certRequest['verifyhost'])) {
                        $this->setCurlOption(CURLOPT_SSL_VERIFYHOST, $this->certRequest['verifyhost']);
                    } else {
                        $this->setCurlOption(CURLOPT_SSL_VERIFYHOST, 1);
                    }
                    if (isset($this->certRequest['sslcertfile'])) {
                        $this->setCurlOption(CURLOPT_SSLCERT, $this->certRequest['sslcertfile']);
                    }
                    if (isset($this->certRequest['sslkeyfile'])) {
                        $this->setCurlOption(CURLOPT_SSLKEY, $this->certRequest['sslkeyfile']);
                    }
                    if (isset($this->certRequest['passphrase'])) {
                        $this->setCurlOption(CURLOPT_SSLKEYPASSWD, $this->certRequest['passphrase']);
                    }
                    if (isset($this->certRequest['certpassword'])) {
                        $this->setCurlOption(CURLOPT_SSLCERTPASSWD, $this->certRequest['certpassword']);
                    }
                }
            }
            if ($this->authtype && ('certificate' !== $this->authtype)) {
                if ($this->username) {
                    $this->debug('set cURL username/password');
                    $this->setCurlOption(CURLOPT_USERPWD, "$this->username:$this->password");
                }
                if ('basic' === $this->authtype) {
                    $this->debug('set cURL for Basic authentication');
                    $this->setCurlOption($CURLOPT_HTTPAUTH, $CURLAUTH_BASIC);
                }
                if ('digest' === $this->authtype) {
                    $this->debug('set cURL for digest authentication');
                    $this->setCurlOption($CURLOPT_HTTPAUTH, $CURLAUTH_DIGEST);
                }
                if ('ntlm' === $this->authtype) {
                    $this->debug('set cURL for NTLM authentication');
                    $this->setCurlOption($CURLOPT_HTTPAUTH, $CURLAUTH_NTLM);
                }
            }
            if (is_array($this->proxy)) {
                $this->debug('set cURL proxy options');
                if ('' !== $this->proxy['port']) {
                    $this->setCurlOption(CURLOPT_PROXY, $this->proxy['host'] . ':' . $this->proxy['port']);
                } else {
                    $this->setCurlOption(CURLOPT_PROXY, $this->proxy['host']);
                }
                if ($this->proxy['username'] || $this->proxy['password']) {
                    $this->debug('set cURL proxy authentication options');
                    $this->setCurlOption(CURLOPT_PROXYUSERPWD, $this->proxy['username'] . ':' . $this->proxy['password']);
                    if ('basic' === $this->proxy['authtype']) {
                        $this->setCurlOption($CURLOPT_PROXYAUTH, $CURLAUTH_BASIC);
                    }
                    if ('ntlm' === $this->proxy['authtype']) {
                        $this->setCurlOption($CURLOPT_PROXYAUTH, $CURLAUTH_NTLM);
                    }
                }
            }
            $this->debug('cURL connection set up');

            return true;
        }
        $this->setError('Unknown scheme ' . $this->scheme);
        $this->debug('Unknown scheme ' . $this->scheme);

        return false;
    }

    /**
     * sends the SOAP request and gets the SOAP response via HTTP[S]
     *
     * @param  string $data             message data
     * @param int     $timeout          set connection timeout in seconds
     * @param int     $response_timeout set response timeout in seconds
     * @param  array  $cookies          cookies to send
     * @return string  data
     */
    public function send($data, $timeout = 0, $response_timeout = 30, $cookies = null)
    {
        $this->debug('entered send() with data of length: ' . mb_strlen($data));

        $this->tryagain = true;

        $tries          = 0;
        while ($this->tryagain) {
            $this->tryagain = false;
            if (++$tries < 2) {
                // make connnection
                if (!$this->connect($timeout, $response_timeout)) {
                    return false;

                }

                // send request
                if (!$this->sendRequest($data, $cookies)) {
                    return false;

                }

                // get response
                $respdata = $this->getResponse();
            } else {
                $this->setError("Too many tries to get an OK response ($this->response_status_line)");
            }
        }
        $this->debug('end of send()');

        return $respdata;

    }

    /**
     * sends the SOAP request and gets the SOAP response via HTTPS using CURL
     *
     * @param  string $data             message data
     * @param int     $timeout          set connection timeout in seconds
     * @param int     $response_timeout set response timeout in seconds
     * @param  array  $cookies          cookies to send
     * @return string  data
     * @deprecated
     */
    public function sendHTTPS($data, $timeout, $response_timeout, $cookies)
    {
        return $this->send($data, $timeout, $response_timeout, $cookies);
    }

    /**
     * if authenticating, set user credentials here
     *
     * @param string $username
     * @param string $password
     * @param string $authtype      (basic|digest|certificate|ntlm)
     * @param array  $digestRequest (keys must be nonce, nc, realm, qop)
     * @param array  $certRequest   (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, certpassword (optional), verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)
     */
    public function setCredentials(
        $username,
        $password,
        $authtype = 'basic',
        $digestRequest = [],
        $certRequest = [])
    {
        $this->debug("setCredentials username=$username authtype=$authtype digestRequest=");
        $this->appendDebug($this->varDump($digestRequest));
        $this->debug('certRequest=');
        $this->appendDebug($this->varDump($certRequest));
        // cf. RFC 2617
        if ('basic' === $authtype) {
            $this->setHeader('Authorization', 'Basic ' . base64_encode(str_replace(':', '', $username) . ':' . $password));
        } elseif ('digest' === $authtype) {
            if (isset($digestRequest['nonce'])) {
                $digestRequest['nc'] = isset($digestRequest['nc']) ? $digestRequest['nc']++ : 1;

                // calculate the Digest hashes (calculate code based on digest implementation found at: http://www.rassoc.com/gregr/weblog/stories/2002/07/09/webServicesSecurityHttpDigestAuthenticationWithoutActiveDirectory.html)

                // A1 = unq(username-value) ":" unq(realm-value) ":" passwd
                $A1 = $username . ':' . (isset($digestRequest['realm']) ? $digestRequest['realm'] : '') . ':' . $password;

                // H(A1) = MD5(A1)
                $HA1 = md5($A1);

                // A2 = Method ":" digest-uri-value
                $A2 = $this->request_method . ':' . $this->digest_uri;

                // H(A2)
                $HA2 = md5($A2);

                // KD(secret, data) = H(concat(secret, ":", data))
                // if qop == auth:
                // request-digest  = <"> < KD ( H(A1),     unq(nonce-value)
                //                              ":" nc-value
                //                              ":" unq(cnonce-value)
                //                              ":" unq(qop-value)
                //                              ":" H(A2)
                //                            ) <">
                // if qop is missing,
                // request-digest  = <"> < KD ( H(A1), unq(nonce-value) ":" H(A2) ) > <">

                $unhashedDigest = '';
                $nonce          = isset($digestRequest['nonce']) ? $digestRequest['nonce'] : '';
                $cnonce         = $nonce;
                if ('' !== $digestRequest['qop']) {
                    $unhashedDigest = $HA1 . ':' . $nonce . ':' . sprintf('%08d', $digestRequest['nc']) . ':' . $cnonce . ':' . $digestRequest['qop'] . ':' . $HA2;
                } else {
                    $unhashedDigest = $HA1 . ':' . $nonce . ':' . $HA2;
                }

                $hashedDigest = md5($unhashedDigest);

                $opaque = '';
                if (isset($digestRequest['opaque'])) {
                    $opaque = ', opaque="' . $digestRequest['opaque'] . '"';
                }

                $this->setHeader('Authorization', 'Digest username="'
                                                  . $username
                                                  . '", realm="'
                                                  . $digestRequest['realm']
                                                  . '", nonce="'
                                                  . $nonce
                                                  . '", uri="'
                                                  . $this->digest_uri
                                                  . $opaque
                                                  . '", cnonce="'
                                                  . $cnonce
                                                  . '", nc='
                                                  . sprintf('%08x', $digestRequest['nc'])
                                                  . ', qop="'
                                                  . $digestRequest['qop']
                                                  . '", response="'
                                                  . $hashedDigest
                                                  . '"');
            }
        } elseif ('certificate' === $authtype) {
            $this->certRequest = $certRequest;
            $this->debug('Authorization header not set for certificate');
        } elseif ('ntlm' === $authtype) {
            // do nothing
            $this->debug('Authorization header not set for ntlm');
        }
        $this->username      = $username;
        $this->password      = $password;
        $this->authtype      = $authtype;
        $this->digestRequest = $digestRequest;
    }

    /**
     * set the soapaction value
     *
     * @param string $soapaction
     */
    public function setSOAPAction($soapaction)
    {
        $this->setHeader('SOAPAction', '"' . $soapaction . '"');
    }

    /**
     * use http encoding
     *
     * @param string $enc encoding style. supported values: gzip, deflate, or both
     */
    public function setEncoding($enc = 'gzip, deflate')
    {
        if (function_exists('gzdeflate')) {
            $this->protocol_version = '1.1';
            $this->setHeader('Accept-Encoding', $enc);
            if (!isset($this->outgoing_headers['Connection'])) {
                $this->setHeader('Connection', 'close');
                $this->persistentConnection = false;
            }
            // deprecated as of PHP 5.3.0
            //set_magic_quotes_runtime(0);
            $this->encoding = $enc;
        }
    }

    /**
     * set proxy info here
     *
     * @param    bool|string $proxyhost     use an empty string to remove proxy
     * @param    bool|string $proxyport
     * @param    bool|string $proxyusername
     * @param    bool|string $proxypassword
     * @param    bool|string $proxyauthtype (basic|ntlm)
     */
    public function setProxy(
        $proxyhost,
        $proxyport,
        $proxyusername = '',
        $proxypassword = '',
        $proxyauthtype = 'basic')
    {
        if ($proxyhost) {
            $this->proxy = [
                'host'     => $proxyhost,
                'port'     => $proxyport,
                'username' => $proxyusername,
                'password' => $proxypassword,
                'authtype' => $proxyauthtype,
            ];
            if ('' !== $proxyusername && '' !== $proxypassword && $proxyauthtype = 'basic') {

                $this->setHeader('Proxy-Authorization', ' Basic ' . base64_encode($proxyusername . ':' . $proxypassword));
            }
        } else {
            $this->debug('remove proxy');
            $proxy = null;

            $this->unsetHeader('Proxy-Authorization');
        }
    }

    /**
     * Test if the given string starts with a header that is to be skipped.
     * Skippable headers result from chunked transfer and proxy requests.
     *
     * @param string $data The string to check.
     * @returns boolean Whether a skippable header was found.
     * @return bool
     */
    private function isSkippableCurlHeader(&$data)
    {
        $skipHeaders = [
            'HTTP/1.1 100',
            'HTTP/1.0 301',
            'HTTP/1.1 301',
            'HTTP/1.0 302',
            'HTTP/1.1 302',
            'HTTP/1.0 401',
            'HTTP/1.1 401',
            'HTTP/1.0 200 Connection established',
        ];
        foreach ($skipHeaders as $hd) {
            $prefix = mb_substr($data, 0, mb_strlen($hd));
            if ($prefix == $hd) {
                return true;
            }
        }

        return false;
    }

    /**
     * decode a string that is encoded w/ "chunked' transfer encoding
     * as defined in RFC2068 19.4.6
     *
     * @param string $buffer
     * @param string $lb
     * @returns  string
     * @deprecated
     * @return string
     */
    public function decodeChunked($buffer, $lb)
    {
        // length := 0
        $length = 0;
        $new    = '';

        // read chunk-size, chunk-extension (if any) and CRLF
        // get the position of the linebreak
        $chunkend = mb_strpos($buffer, $lb);
        if (false === $chunkend) {
            $this->debug('no linebreak found in decodeChunked');

            return $new;
        }
        $temp       = mb_substr($buffer, 0, $chunkend);
        $chunk_size = hexdec(trim($temp));
        $chunkstart = $chunkend + mb_strlen($lb);
        // while (chunk-size > 0) {
        while ($chunk_size > 0) {
            $this->debug("chunkstart: $chunkstart chunk_size: $chunk_size");
            $chunkend = mb_strpos($buffer, $lb, $chunkstart + $chunk_size);
            $chunkend = mb_strpos($buffer, $lb, /** @scrutinizer ignore-type */ $chunkstart + $chunk_size);

            // Just in case we got a broken connection
            if (false === $chunkend) {
                $chunk = mb_substr($buffer, $chunkstart);
                // append chunk-data to entity-body
                $new    .= $chunk;
                $length += mb_strlen($chunk);
                break;
            }

            // read chunk-data and CRLF
            $chunk = mb_substr($buffer, $chunkstart, $chunkend - $chunkstart);
            // append chunk-data to entity-body
            $new .= $chunk;
            // length := length + chunk-size
            $length += mb_strlen($chunk);
            // read chunk-size and CRLF
            $chunkstart = $chunkend + mb_strlen($lb);

            $chunkend = mb_strpos($buffer, $lb, $chunkstart) + mb_strlen($lb);
            if (false === $chunkend) {
                break; //Just in case we got a broken connection
            }
            $temp       = mb_substr($buffer, $chunkstart, $chunkend - $chunkstart);
            $chunk_size = hexdec(trim($temp));
            $chunkstart = $chunkend;
        }

        return $new;
    }

    /**
     * Writes the payload, including HTTP headers, to $this->outgoing_payload.
     *
     * @param  string $data       HTTP body
     * @param  string $cookie_str data for HTTP Cookie header
     */
    private function buildPayload($data, $cookie_str = '')
    {
        // Note: for cURL connections, $this->outgoing_payload is ignored,
        // as is the Content-Length header, but these are still created as
        // debugging guides.

        // add content-length header
        if ('GET' !== $this->request_method) {
            $this->setHeader('Content-Length', mb_strlen($data));
        }

        // start building outgoing payload:
        if ($this->proxy) {
            $uri = $this->url;
        } else {
            $uri = $this->uri;
        }
        $req = "$this->request_method $uri HTTP/$this->protocol_version";
        $this->debug("HTTP request: $req");
        $this->outgoing_payload = "$req\r\n";

        // loop thru headers, serializing
        foreach ($this->outgoing_headers as $k => $v) {
            $hdr = $k . ': ' . $v;
            $this->debug("HTTP header: $hdr");
            $this->outgoing_payload .= "$hdr\r\n";
        }

        // add any cookies
        if ('' !== $cookie_str) {
            $hdr = 'Cookie: ' . $cookie_str;
            $this->debug("HTTP header: $hdr");
            $this->outgoing_payload .= "$hdr\r\n";
        }

        // header/body separator
        $this->outgoing_payload .= "\r\n";

        // add data
        $this->outgoing_payload .= $data;
    }

    /**
     * sends the SOAP request via HTTP[S]
     *
     * @param  string $data    message data
     * @param  array  $cookies cookies to send
     * @return bool true if OK, false if problem
     */
    private function sendRequest($data, $cookies = null)
    {
        // build cookie string
        $cookie_str = $this->getCookiesForRequest($cookies, ('ssl' === $this->scheme) || ('https' === $this->scheme));

        // build payload
        $this->buildPayload($data, $cookie_str);

        if ('socket' === $this->io_method()) {
            // send payload
            if (!fwrite($this->fp, $this->outgoing_payload, mb_strlen($this->outgoing_payload))) {
                $this->setError('couldn\'t write message data to socket');
                $this->debug('couldn\'t write message data to socket');

                return false;
            }
            $this->debug('wrote data to socket, length = ' . mb_strlen($this->outgoing_payload));

            return true;
        }

        if ('curl' === $this->io_method()) {
            // set payload
            // cURL does say this should only be the verb, and in fact it
            // turns out that the URI and HTTP version are appended to this, which
            // some servers refuse to work with (so we no longer use this method!)
            //$this->setCurlOption(CURLOPT_CUSTOMREQUEST, $this->outgoing_payload);
            $curl_headers = [];
            foreach ($this->outgoing_headers as $k => $v) {
                if ('Connection' === $k || 'Content-Length' === $k || 'Host' === $k || 'Authorization' === $k || 'Proxy-Authorization' === $k) {
                    $this->debug("Skip cURL header $k: $v");
                } else {
                    $curl_headers[] = "$k: $v";
                }
            }
            if ('' !== $cookie_str) {
                $curl_headers[] = 'Cookie: ' . $cookie_str;
            }
            $this->setCurlOption(CURLOPT_HTTPHEADER, $curl_headers);
            $this->debug('set cURL HTTP headers');
            if ('POST' === $this->request_method) {
                $this->setCurlOption(CURLOPT_POST, 1);
                $this->setCurlOption(CURLOPT_POSTFIELDS, $data);
                $this->debug('set cURL POST data');
            }

            // insert custom user-set cURL options
            foreach ($this->ch_options as $key => $val) {
                $this->setCurlOption($key, $val);
            }

            $this->debug('set cURL payload');

            return true;
        }
    }

    /**
     * gets the SOAP response via HTTP[S]
     *
     * @return string the response (also sets member variables like incoming_payload)
     */
    private function getResponse()
    {
        $this->incoming_payload = '';

        if ('socket' === $this->io_method()) {
            // loop until headers have been retrieved
            $data = '';
            while (!isset($lb)) {
                // We might EOF during header read.
                if (feof($this->fp)) {
                    $this->incoming_payload = $data;
                    $this->debug('found no headers before EOF after length ' . mb_strlen($data));
                    $this->debug("received before EOF:\n" . $data);
                    $this->setError('server failed to send headers');

                    return false;

                }

                $tmp    = fgets($this->fp, 256);
                $tmplen = mb_strlen($tmp);
                $this->debug("read line of $tmplen bytes: " . trim($tmp));

                if (0 == $tmplen) {
                    $this->incoming_payload = $data;
                    $this->debug('socket read of headers timed out after length ' . mb_strlen($data));
                    $this->debug('read before timeout: ' . $data);
                    $this->setError('socket read of headers timed out');

                    return false;

                }

                $data .= $tmp;
                $pos  = mb_strpos($data, "\r\n\r\n");
                if ($pos > 1) {
                    $lb = "\r\n";
                } else {
                    $pos = mb_strpos($data, "\n\n");
                    if ($pos > 1) {
                        $lb = "\n";
                    }
                }
                // remove 100 headers
                if (isset($lb) && preg_match('/^HTTP\/1.1 100/', $data)) {
                    unset($lb);
                    $data = '';
                }
            }
            // store header data
            $this->incoming_payload .= $data;
            $this->debug('found end of headers after length ' . mb_strlen($data));
            // process headers
            $header_data            = trim(mb_substr($data, 0, $pos));

            $header_array           = explode($lb, $header_data);

            $this->incoming_headers = [];
            $this->incoming_cookies = [];
            foreach ($header_array as $header_line) {
                $arr = explode(':', $header_line, 2);
                if (is_array($arr) && count($arr) > 1) {
                    $header_name                          = mb_strtolower(trim($arr[0]));
                    $this->incoming_headers[$header_name] = trim($arr[1]);
                    if ('set-cookie' === $header_name) {
                        // TODO: allow multiple cookies from parseCookie
                        $cookie = $this->parseCookie(trim($arr[1]));
                        if ($cookie) {
                            $this->incoming_cookies[] = $cookie;
                            $this->debug('found cookie: ' . $cookie['name'] . ' = ' . $cookie['value']);
                        } else {
                            $this->debug('did not find cookie in ' . trim($arr[1]));
                        }
                    }
                } elseif (isset($header_name)) {
                    // append continuation line to previous header
                    $this->incoming_headers[$header_name] .= $lb . ' ' . $header_line;
                }
            }

            // loop until msg has been received
            if (isset($this->incoming_headers['transfer-encoding']) && 'chunked' === mb_strtolower($this->incoming_headers['transfer-encoding'])) {
                $content_length = 2147483647;    // ignore any content-length header
                $chunked        = true;
                $this->debug('want to read chunked content');
            } elseif (isset($this->incoming_headers['content-length'])) {
                $content_length = $this->incoming_headers['content-length'];
                $chunked        = false;
                $this->debug("want to read content of length $content_length");
            } else {
                $content_length = 2147483647;
                $chunked        = false;
                $this->debug('want to read content to EOF');
            }
            $data = '';
            do {
                if ($chunked) {
                    $tmp    = fgets($this->fp, 256);
                    $tmplen = mb_strlen($tmp);
                    $this->debug("read chunk line of $tmplen bytes");
                    if (0 == $tmplen) {
                        $this->incoming_payload = $data;
                        $this->debug('socket read of chunk length timed out after length ' . mb_strlen($data));
                        $this->debug("read before timeout:\n" . $data);
                        $this->setError('socket read of chunk length timed out');

                        return false;

                    }
                    $content_length = hexdec(trim($tmp));
                    $this->debug("chunk length $content_length");
                }
                $strlen = 0;
                while (($strlen < $content_length) && (!feof($this->fp))) {
                    $readlen = min(8192, $content_length - $strlen);
                    $tmp     = fread($this->fp, $readlen);
                    $tmplen  = mb_strlen($tmp);
                    $this->debug("read buffer of $tmplen bytes");
                    if ((0 == $tmplen) && (!feof($this->fp))) {
                        $this->incoming_payload = $data;
                        $this->debug('socket read of body timed out after length ' . mb_strlen($data));
                        $this->debug("read before timeout:\n" . $data);
                        $this->setError('socket read of body timed out');

                        return false;

                    }
                    $strlen += $tmplen;
                    $data   .= $tmp;
                }
                if ($chunked && ($content_length > 0)) {
                    $tmp    = fgets($this->fp, 256);
                    $tmplen = mb_strlen($tmp);
                    $this->debug("read chunk terminator of $tmplen bytes");
                    if (0 == $tmplen) {
                        $this->incoming_payload = $data;
                        $this->debug('socket read of chunk terminator timed out after length ' . mb_strlen($data));
                        $this->debug("read before timeout:\n" . $data);
                        $this->setError('socket read of chunk terminator timed out');

                        return false;

                    }
                }
            } while ($chunked && ($content_length > 0) && (!feof($this->fp)));
            if (feof($this->fp)) {
                $this->debug('read to EOF');
            }
            $this->debug('read body of length ' . mb_strlen($data));
            $this->incoming_payload .= $data;
            $this->debug('received a total of ' . mb_strlen($this->incoming_payload) . ' bytes of data from server');

            // close filepointer
            if ((isset($this->incoming_headers['connection']) && 'close' === mb_strtolower($this->incoming_headers['connection'])) || (!$this->persistentConnection) || feof($this->fp)) {
                fclose($this->fp);
                $this->fp = false;

                $this->debug('closed socket');
            }

            // connection was closed unexpectedly
            if ('' === $this->incoming_payload) {
                $this->setError('no response from server');

                return false;

            }

            // decode transfer-encoding
            //      if (isset($this->incoming_headers['transfer-encoding']) && strtolower($this->incoming_headers['transfer-encoding']) == 'chunked') {
            //          if (!$data = $this->decodeChunked($data, $lb)) {
            //              $this->setError('Decoding of chunked data failed');
            //              return false;
            //          }
            //print "<pre>\nde-chunked:\n---------------\n$data\n\n---------------\n</pre>";
            // set decoded payload
            //          $this->incoming_payload = $header_data.$lb.$lb.$data;
            //      }
        } elseif ('curl' === $this->io_method()) {
            // send and receive
            $this->debug('send and receive with cURL');
            $this->incoming_payload = curl_exec($this->ch);
            $this->incoming_payload = curl_exec(/** @scrutinizer ignore-type */ $this->ch);
            $data                   = $this->incoming_payload;

            $cErr = curl_error($this->ch);
            $cErr = curl_error(/** @scrutinizer ignore-type */ $this->ch);
            if ('' !== $cErr) {
                $err = 'cURL ERROR: ' . curl_errno($this->ch) . ': ' . $cErr . '<br>';
                $err = 'cURL ERROR: ' . curl_errno(/** @scrutinizer ignore-type */ $this->ch) . ': ' . $cErr . '<br>';
                // TODO: there is a PHP bug that can cause this to SEGV for CURLINFO_CONTENT_TYPE
                foreach (curl_getinfo($this->ch) as $k => $v) {
                foreach (curl_getinfo(/** @scrutinizer ignore-type */ $this->ch) as $k => $v) {
                    $err .= "$k: $v<br>";
                }
                $this->debug($err);
                $this->setError($err);
                curl_close($this->ch);
                curl_close(/** @scrutinizer ignore-type */ $this->ch);

                return false;

            }

            //echo '<pre>';
            //var_dump(curl_getinfo($this->ch));
            //echo '</pre>';
            // close curl
            $this->debug('No cURL error, closing cURL');
            curl_close($this->ch);

            // try removing skippable headers
            $savedata = $data;
            while ($this->isSkippableCurlHeader($data)) {
            while ($this->isSkippableCurlHeader(/** @scrutinizer ignore-type */ $data)) {
                $this->debug('Found HTTP header to skip');
                if (false !== ($pos = mb_strpos($data, "\r\n\r\n"))) {
                    $data = ltrim(mb_substr($data, $pos));
                } elseif (false !== ($pos = mb_strpos($data, "\n\n"))) {
                    $data = ltrim(mb_substr($data, $pos));
                }
            }

            if ('' === $data) {
                // have nothing left; just remove 100 header(s)
                $data = $savedata;
                while (preg_match('/^HTTP\/1.1 100/', $data)) {
                while (preg_match('/^HTTP\/1.1 100/', /** @scrutinizer ignore-type */ $data)) {
                    if (false !== ($pos = mb_strpos($data, "\r\n\r\n"))) {
                    if (false !== ($pos = mb_strpos(/** @scrutinizer ignore-type */ $data, "\r\n\r\n"))) {
                        $data = ltrim(mb_substr($data, $pos));
                        $data = ltrim(mb_substr(/** @scrutinizer ignore-type */ $data, $pos));
                    } elseif (false !== ($pos = mb_strpos($data, "\n\n"))) {
                        $data = ltrim(mb_substr($data, $pos));
                    }
                }
            }

            // separate content from HTTP headers
            if (false !== ($pos = mb_strpos($data, "\r\n\r\n"))) {
                $lb = "\r\n";
            } elseif (false !== ($pos = mb_strpos($data, "\n\n"))) {
                $lb = "\n";
            } else {
                $this->debug('no proper separation of headers and document');
                $this->setError('no proper separation of headers and document');

                return false;

            }
            $header_data  = trim(mb_substr($data, 0, $pos));
            $header_array = explode($lb, $header_data);
            $data         = ltrim(mb_substr($data, $pos));
            $this->debug('found proper separation of headers and document');
            $this->debug('cleaned data, stringlen: ' . mb_strlen($data));
            // clean headers
            foreach ($header_array as $header_line) {
                $arr = explode(':', $header_line, 2);
                if (is_array($arr) && count($arr) > 1) {
                    $header_name                          = mb_strtolower(trim($arr[0]));
                    $this->incoming_headers[$header_name] = trim($arr[1]);
                    if ('set-cookie' === $header_name) {
                        // TODO: allow multiple cookies from parseCookie
                        $cookie = $this->parseCookie(trim($arr[1]));
                        if ($cookie) {
                            $this->incoming_cookies[] = $cookie;
                            $this->debug('found cookie: ' . $cookie['name'] . ' = ' . $cookie['value']);
                        } else {
                            $this->debug('did not find cookie in ' . trim($arr[1]));
                        }
                    }
                } elseif (isset($header_name)) {
                    // append continuation line to previous header
                    $this->incoming_headers[$header_name] .= $lb . ' ' . $header_line;
                }
            }
        }

        $this->response_status_line = $header_array[0];

        $arr                        = explode(' ', $this->response_status_line, 3);
        $http_version               = $arr[0];

        $http_status                = (int)$arr[1];
        $http_reason                = count($arr) > 2 ? $arr[2] : '';

        // see if we need to resend the request with http digest authentication
        if (isset($this->incoming_headers['location']) && (301 == $http_status || 302 == $http_status)) {
            $this->debug("Got $http_status $http_reason with Location: " . $this->incoming_headers['location']);
            $this->setURL($this->incoming_headers['location']);
            $this->tryagain = true;


            return false;

        }

        // see if we need to resend the request with http digest authentication
        if (isset($this->incoming_headers['www-authenticate']) && 401 == $http_status) {
            $this->debug("Got 401 $http_reason with WWW-Authenticate: " . $this->incoming_headers['www-authenticate']);
            if (false !== mb_strpos($this->incoming_headers['www-authenticate'], 'Digest ')) {
                $this->debug('Server wants digest authentication');
                // remove "Digest " from our elements
                $digestString = str_replace('Digest ', '', $this->incoming_headers['www-authenticate']);

                // parse elements into array
                $digestElements = explode(',', $digestString);
                foreach ($digestElements as $val) {
                    $tempElement                    = explode('=', trim($val), 2);
                    $digestRequest[$tempElement[0]] = str_replace('"', '', $tempElement[1]);
                }

                // should have (at least) qop, realm, nonce
                if (isset($digestRequest['nonce'])) {
                    $this->setCredentials($this->username, $this->password, 'digest', $digestRequest);

                    $this->tryagain = true;

                    return false;

                }
            }
            $this->debug('HTTP authentication failed');
            $this->setError('HTTP authentication failed');

            return false;

        }

        if (($http_status >= 300 && $http_status <= 307) || ($http_status >= 400 && $http_status <= 417) || ($http_status >= 501 && $http_status <= 505)) {
            $this->setError("Unsupported HTTP response status $http_status $http_reason (soapclient->response has contents of the response)");

            return false;

        }

        // decode content-encoding
        if (isset($this->incoming_headers['content-encoding']) && '' !== $this->incoming_headers['content-encoding']) {
            if ('deflate' === mb_strtolower($this->incoming_headers['content-encoding']) || 'gzip' === mb_strtolower($this->incoming_headers['content-encoding'])) {
                // if decoding works, use it. else assume data wasn't gzencoded
                if (function_exists('gzinflate')) {
                    //$timer->setMarker('starting decoding of gzip/deflated content');
                    // IIS 5 requires gzinflate instead of gzuncompress (similar to IE 5 and gzdeflate v. gzcompress)
                    // this means there are no Zlib headers, although there should be
                    $this->debug('The gzinflate function exists');
                    $datalen = mb_strlen($data);

                    if ('deflate' === $this->incoming_headers['content-encoding']) {
                        if (false !== ($degzdata = @gzinflate($data))) {
                            $data = $degzdata;
                            $this->debug('The payload has been inflated to ' . mb_strlen($data) . ' bytes');
                            if (mb_strlen($data) < $datalen) {
                                // test for the case that the payload has been compressed twice
                                $this->debug('The inflated payload is smaller than the gzipped one; try again');
                                if (false !== ($degzdata = @gzinflate($data))) {
                                    $data = $degzdata;
                                    $this->debug('The payload has been inflated again to ' . mb_strlen($data) . ' bytes');
                                }
                            }
                        } else {
                            $this->debug('Error using gzinflate to inflate the payload');
                            $this->setError('Error using gzinflate to inflate the payload');
                        }
                    } elseif ('gzip' === $this->incoming_headers['content-encoding']) {
                        if (false !== ($degzdata = @gzinflate(mb_substr($data, 10)))) {
                            // do our best
                            $data = $degzdata;
                            $this->debug('The payload has been un-gzipped to ' . mb_strlen($data) . ' bytes');
                            if (mb_strlen($data) < $datalen) {
                                // test for the case that the payload has been compressed twice
                                $this->debug('The un-gzipped payload is smaller than the gzipped one; try again');
                                if (false !== ($degzdata = @gzinflate(mb_substr($data, 10)))) {
                                    $data = $degzdata;
                                    $this->debug('The payload has been un-gzipped again to ' . mb_strlen($data) . ' bytes');
                                }
                            }
                        } else {
                            $this->debug('Error using gzinflate to un-gzip the payload');
                            $this->setError('Error using gzinflate to un-gzip the payload');
                        }
                    }
                    //$timer->setMarker('finished decoding of gzip/deflated content');
                    //print "<xmp>\nde-inflated:\n---------------\n$data\n-------------\n</xmp>";
                    // set decoded payload
                    $this->incoming_payload = $header_data . $lb . $lb . $data;

                } else {
                    $this->debug('The server sent compressed data. Your php install must have the Zlib extension compiled in to support this.');
                    $this->setError('The server sent compressed data. Your php install must have the Zlib extension compiled in to support this.');
                }
            } else {
                $this->debug('Unsupported Content-Encoding ' . $this->incoming_headers['content-encoding']);
                $this->setError('Unsupported Content-Encoding ' . $this->incoming_headers['content-encoding']);
            }
        } else {
            $this->debug('No Content-Encoding header');
        }

        if ('' === $data) {
            $this->debug('no data after headers!');
            $this->setError('no data present after HTTP headers');

            return false;

        }

        return $data;
    }

    /**
     * sets the content-type for the SOAP message to be sent
     *
     * @param string $type    the content type, MIME style
     * @param mixed  $charset character set used for encoding (or false)
     */
    public function setContentType($type, $charset = false)
    {
        $this->setHeader('Content-Type', $type . ($charset ? '; charset=' . $charset : ''));
    }

    /**
     * specifies that an HTTP persistent connection should be used
     *
     * @return bool whether the request was honored by this method.
     */
    public function usePersistentConnection()
    {
        if (isset($this->outgoing_headers['Accept-Encoding'])) {
            return false;
        }
        $this->protocol_version     = '1.1';
        $this->persistentConnection = true;
        $this->setHeader('Connection', 'Keep-Alive');

        return true;
    }

    /**
     * parse an incoming Cookie into it's parts
     *
     * @param  string $cookie_str content of cookie
     * @return    bool|array with data of that cookie
     */
    /*
     * TODO: allow a Set-Cookie string to be parsed into multiple cookies
     */
    private function parseCookie($cookie_str)
    {
        $cookie_str = str_replace('; ', ';', $cookie_str) . ';';
        $data       = preg_split('/;/', $cookie_str);
        $value_str  = $data[0];

        $cookie_param = 'domain=';
        $start        = mb_strpos($cookie_str, $cookie_param);
        if ($start > 0) {
            $domain = mb_substr($cookie_str, $start + mb_strlen($cookie_param));
            $domain = mb_substr($domain, 0, mb_strpos($domain, ';'));
        } else {
            $domain = '';
        }

        $cookie_param = 'expires=';
        $start        = mb_strpos($cookie_str, $cookie_param);
        if ($start > 0) {
            $expires = mb_substr($cookie_str, $start + mb_strlen($cookie_param));
            $expires = mb_substr($expires, 0, mb_strpos($expires, ';'));
        } else {
            $expires = '';
        }

        $cookie_param = 'path=';
        $start        = mb_strpos($cookie_str, $cookie_param);
        if ($start > 0) {
            $path = mb_substr($cookie_str, $start + mb_strlen($cookie_param));
            $path = mb_substr($path, 0, mb_strpos($path, ';'));
        } else {
            $path = '/';
        }

        $cookie_param = ';secure;';
        $secure       = false;
        if (false !== mb_strpos($cookie_str, $cookie_param)) {
            $secure = true;
        }

        $sep_pos = mb_strpos($value_str, '=');

        if ($sep_pos) {
            $name   = mb_substr($value_str, 0, $sep_pos);
            $value  = mb_substr($value_str, $sep_pos + 1);
            $cookie = [
                'name'    => $name,
                'value'   => $value,
                'domain'  => $domain,
                'path'    => $path,
                'expires' => $expires,
                'secure'  => $secure,
            ];

            return $cookie;
        }

        return false;
    }

    /**
     * sort out cookies for the current request
     *
     * @param    array|null $cookies array with all cookies
     * @param  bool         $secure  is the send-content secure or not?
     * @return string  for Cookie-HTTP-Header
     */
    private function getCookiesForRequest($cookies, $secure = false)
    {
        $cookie_str = '';
        if ((null !== $cookies) && is_array($cookies)) {
            foreach ($cookies as $cookie) {
                if (!is_array($cookie)) {
                    continue;
                }
                $this->debug('check cookie for validity: ' . $cookie['name'] . '=' . $cookie['value']);
                if (isset($cookie['expires']) && !empty($cookie['expires'])) {
                    if (strtotime($cookie['expires']) <= time()) {
                        $this->debug('cookie has expired');
                        continue;
                    }
                }
                if (isset($cookie['domain']) && !empty($cookie['domain'])) {
                    $domain = preg_quote($cookie['domain']);
                    if (!preg_match("'.*$domain$'i", $this->host)) {
                        $this->debug('cookie has different domain');
                        continue;
                    }
                }
                if (isset($cookie['path']) && !empty($cookie['path'])) {
                    $path = preg_quote($cookie['path']);
                    if (!preg_match("'^$path.*'i", $this->path)) {
                        $this->debug('cookie is for a different path');
                        continue;
                    }
                }
                if ((!$secure) && isset($cookie['secure']) && $cookie['secure']) {
                    $this->debug('cookie is secure, transport is not');
                    continue;
                }
                $cookie_str .= $cookie['name'] . '=' . $cookie['value'] . '; ';
                $this->debug('add cookie to Cookie-String: ' . $cookie['name'] . '=' . $cookie['value']);
            }
        }

        return $cookie_str;
    }
}

/**
 * nusoap_server allows the user to create a SOAP server
 * that is capable of receiving messages and returning responses
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Nusoap_server extends Nusoap_base
{
    /**
     * HTTP headers of request
     *
     * @var array
     */
    private $headers = [];
    /**
     * HTTP request
     *
     * @var string
     */
    private $request = '';
    /**
     * SOAP headers from request (incomplete namespace resolution; special characters not escaped) (text)
     *
     * @var string
     */
    public $requestHeaders = '';
    /**
     * SOAP Headers from request (parsed)
     *
     * @var mixed
     */
    public $requestHeader;
    /**
     * SOAP body request portion (incomplete namespace resolution; special characters not escaped) (text)
     *
     * @var string
     */
    public $document = '';
    /**
     * SOAP payload for request (text)
     *
     * @var string
     */
    public $requestSOAP = '';
    /**
     * requested method namespace URI
     *
     * @var string
     */
    private $methodURI = '';
    /**
     * name of method requested
     *
     * @var string
     */
    private $methodname = '';
    /**
     * method parameters from request
     *
     * @var array
     */
    private $methodparams = [];
    /**
     * SOAP Action from request
     *
     * @var string
     */
    private $SOAPAction = '';
    /**
     * character set encoding of incoming (request) messages
     *
     * @var string
     */
    public $xml_encoding = '';
    /**
     * toggles whether the parser decodes element content w/ utf8_decode()
     *
     * @var bool
     */
    public $decode_utf8 = true;

    /**
     * HTTP headers of response
     *
     * @var array
     */
    public $outgoing_headers = [];
    /**
     * HTTP response
     *
     * @var string
     */
    private $response = '';
    /**
     * SOAP headers for response (text or array of soapval or associative array)
     *
     * @var mixed
     */
    public $responseHeaders = '';
    /**
     * SOAP payload for response (text)
     *
     * @var string
     */
    private $responseSOAP = '';
    /**
     * method return value to place in response
     *
     * @var mixed
     */
    private $methodreturn = false;
    /**
     * whether $methodreturn is a string of literal XML
     *
     * @var bool
     */
    public $methodreturnisliteralxml = false;
    /**
     * SOAP fault for response (or false)
     *
     * @var mixed
     */
    private $fault = false;
    /**
     * text indication of result (for debugging)
     *
     * @var string
     */
    private $result = 'successful';

    /**
     * assoc array of operations => opData; operations are added by the register()
     * method or by parsing an external WSDL definition
     *
     * @var array
     */
    private $operations = [];
    /**
     * wsdl instance (if one)
     *
     * @var mixed
     */
    private $wsdl = false;
    /**
     * URL for WSDL (if one)
     *
     * @var mixed
     */
    private $externalWSDLURL = false;
    /**
     * whether to append debug to response as XML comment
     *
     * @var bool
     */
    public $debug_flag = false;

    /**
     * constructor
     * the optional parameter is a path to a WSDL file that you'd like to bind the server instance to.
     *
     * @param mixed $wsdl file path or URL (string) , or wsdl instance (object)
     */
    public function __construct($wsdl = false)
    {
        parent::__construct();
        // turn on debugging?
        global $debug;
        global $HTTP_SERVER_VARS;

        if (isset($_SERVER)) {
            $this->debug('_SERVER is defined:');
            $this->appendDebug($this->varDump($_SERVER));
        } elseif (isset($HTTP_SERVER_VARS)) {
            $this->debug('HTTP_SERVER_VARS is defined:');
            $this->appendDebug($this->varDump($HTTP_SERVER_VARS));
        } else {
            $this->debug('Neither _SERVER nor HTTP_SERVER_VARS is defined.');
        }

        if (isset($debug)) {
            $this->debug("In nusoap_server, set debug_flag=$debug based on global flag");
            $this->debug_flag = $debug;
        } elseif (\Xmf\Request::hasVar('QUERY_STRING', 'SERVER')) {
            $qs = explode('&', $_SERVER['QUERY_STRING']);
            foreach ($qs as $v) {
                if (0 === mb_strpos($v, 'debug=')) {
                    $this->debug('In nusoap_server, set debug_flag=' . mb_substr($v, 6) . ' based on query string #1');
                    $this->debug_flag = mb_substr($v, 6);
$answer = 42;

$correct = false;

$correct = (bool) $answer;
                }
            }
        } elseif (isset($HTTP_SERVER_VARS['QUERY_STRING'])) {
            $qs = explode('&', $HTTP_SERVER_VARS['QUERY_STRING']);
            foreach ($qs as $v) {
                if (0 === mb_strpos($v, 'debug=')) {
                    $this->debug('In nusoap_server, set debug_flag=' . mb_substr($v, 6) . ' based on query string #2');
                    $this->debug_flag = mb_substr($v, 6);
                }
            }
        }

        // wsdl
        if ($wsdl) {
            $this->debug('In nusoap_server, WSDL is specified');
            if (is_object($wsdl) && ('Wsdl' === get_class($wsdl))) {
                $this->wsdl            = $wsdl;
                $this->externalWSDLURL = $this->wsdl->wsdl;
                $this->debug('Use existing wsdl instance from ' . $this->externalWSDLURL);
            } else {
                $this->debug('Create wsdl from ' . $wsdl);
                $this->wsdl            = new wsdl($wsdl);
                $this->externalWSDLURL = $wsdl;
            }
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            if (false !== ($err = $this->wsdl->getError())) {
                die('WSDL ERROR: ' . $err);

            }
        }
    }

    /**
     * processes request and returns response
     *
     * @param string $data usually is the value of $HTTP_RAW_POST_DATA
     */
    public function service($data)
    {
        global $HTTP_SERVER_VARS;

        $rm = '';
        if (\Xmf\Request::hasVar('REQUEST_METHOD', 'SERVER')) {
            $rm = $_SERVER['REQUEST_METHOD'];
        } elseif (isset($HTTP_SERVER_VARS['REQUEST_METHOD'])) {
            $rm = $HTTP_SERVER_VARS['REQUEST_METHOD'];
        }

        $qs = '';
        if (\Xmf\Request::hasVar('QUERY_STRING', 'SERVER')) {
            $qs = $_SERVER['QUERY_STRING'];
        } elseif (isset($HTTP_SERVER_VARS['QUERY_STRING'])) {
            $qs = $HTTP_SERVER_VARS['QUERY_STRING'];
        }
        $this->debug("In service, request method=$rm query string=$qs strlen(\$data)=" . mb_strlen($data));

        if ('POST' === $rm) {
            $this->debug('In service, invoke the request');
            $this->parse_request($data);
            if (!$this->fault) {
                $this->invoke_method();
            }
            if (!$this->fault) {
                $this->serialize_return();
            }
            $this->send_response();
        } elseif (preg_match('/wsdl/', $qs)) {
            $this->debug('In service, this is a request for WSDL');
            if ($this->externalWSDLURL) {
                if (false !== mb_strpos($this->externalWSDLURL, 'http://')) {
                    // assume URL
                    $this->debug('In service, re-direct for WSDL');
                    header('Location: ' . $this->externalWSDLURL);
                } else {
                    // assume file
                    $this->debug('In service, use file passthru for WSDL');
                    header("Content-Type: text/xml\r\n");
                    $pos = mb_strpos($this->externalWSDLURL, 'file://');
                    if (false === $pos) {
                        $filename = $this->externalWSDLURL;

                    } else {
                        $filename = mb_substr($this->externalWSDLURL, $pos + 7);
                    }
                    $fp = fopen($this->externalWSDLURL, 'rb');
                    fpassthru($fp);
                }
            } elseif ($this->wsdl) {
                $this->debug('In service, serialize WSDL');
                header("Content-Type: text/xml; charset=ISO-8859-1\r\n");
                print $this->wsdl->serialize($this->debug_flag);
                if ($this->debug_flag) {
                    $this->debug('wsdl:');
                    $this->appendDebug($this->varDump($this->wsdl));
                    print $this->getDebugAsXMLComment();
                }
            } else {
                $this->debug('In service, there is no WSDL');
                header("Content-Type: text/html; charset=ISO-8859-1\r\n");
                print 'This service does not provide WSDL';
            }
        } elseif ($this->wsdl) {
            $this->debug('In service, return Web description');
            print $this->wsdl->webDescription();
        } else {
            $this->debug('In service, no Web description');
            header("Content-Type: text/html; charset=ISO-8859-1\r\n");
            print 'This service does not provide a Web description';
        }
    }

    /**
     * parses HTTP request headers.
     *
     * The following fields are set by this function (when successful)
     *
     * headers
     * request
     * xml_encoding
     * SOAPAction
     */
    private function parse_http_headers()
    {
        global $HTTP_SERVER_VARS;

        $this->request    = '';
        $this->SOAPAction = '';
        if (function_exists('getallheaders')) {
            $this->debug('In parse_http_headers, use getallheaders');
            $headers = getallheaders();
            foreach ($headers as $k => $v) {
                $k                 = mb_strtolower($k);
                $this->headers[$k] = $v;
                $this->request     .= "$k: $v\r\n";
                $this->debug("$k: $v");
            }
            // get SOAPAction header
            if (isset($this->headers['soapaction'])) {
                $this->SOAPAction = str_replace('"', '', $this->headers['soapaction']);
            }
            // get the character encoding of the incoming request
            if (isset($this->headers['content-type']) && mb_strpos($this->headers['content-type'], '=')) {
                $enc                = str_replace('"', '', mb_substr(mb_strstr($this->headers['content-type'], '='), 1));
                $this->xml_encoding = 'US-ASCII';
                if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
                    $this->xml_encoding = mb_strtoupper($enc);
                }
            } else {
                // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
                $this->xml_encoding = 'ISO-8859-1';
            }
        } elseif (isset($_SERVER) && is_array($_SERVER)) {
            $this->debug('In parse_http_headers, use _SERVER');
            foreach ($_SERVER as $k => $v) {
                if (0 === mb_strpos($k, 'HTTP_')) {
                    $k = str_replace(' ', '-', mb_strtolower(str_replace('_', ' ', mb_substr($k, 5))));
                } else {
                    $k = str_replace(' ', '-', mb_strtolower(str_replace('_', ' ', $k)));
                }
                if ('soapaction' === $k) {
                    // get SOAPAction header
                    $k                = 'SOAPAction';
                    $v                = str_replace('"', '', $v);
                    $v                = str_replace('\\', '', $v);
                    $this->SOAPAction = $v;
                } elseif ('content-type' === $k) {
                    // get the character encoding of the incoming request
                    if (mb_strpos($v, '=')) {
                        $enc                = mb_substr(mb_strstr($v, '='), 1);
                        $enc                = str_replace('"', '', $enc);
                        $enc                = str_replace('\\', '', $enc);
                        $this->xml_encoding = 'US-ASCII';
                        if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
                            $this->xml_encoding = mb_strtoupper($enc);
                        }
                    } else {
                        // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
                        $this->xml_encoding = 'ISO-8859-1';
                    }
                }
                $this->headers[$k] = $v;
                $this->request     .= "$k: $v\r\n";
                $this->debug("$k: $v");
            }
        } elseif (is_array($HTTP_SERVER_VARS)) {
            $this->debug('In parse_http_headers, use HTTP_SERVER_VARS');
            foreach ($HTTP_SERVER_VARS as $k => $v) {
                if (0 === mb_strpos($k, 'HTTP_')) {
                    $k = str_replace(' ', '-', mb_strtolower(str_replace('_', ' ', mb_substr($k, 5))));
                    $k = mb_strtolower(mb_substr($k, 5));
                } else {
                    $k = str_replace(' ', '-', mb_strtolower(str_replace('_', ' ', $k)));
                    $k = mb_strtolower($k);
                }
                if ('soapaction' === $k) {
                    // get SOAPAction header
                    $k                = 'SOAPAction';
                    $v                = str_replace('"', '', $v);
                    $v                = str_replace('\\', '', $v);
                    $this->SOAPAction = $v;
                } elseif ('content-type' === $k) {
                    // get the character encoding of the incoming request
                    if (mb_strpos($v, '=')) {
                        $enc                = mb_substr(mb_strstr($v, '='), 1);
                        $enc                = str_replace('"', '', $enc);
                        $enc                = str_replace('\\', '', $enc);
                        $this->xml_encoding = 'US-ASCII';
                        if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
                            $this->xml_encoding = mb_strtoupper($enc);
                        }
                    } else {
                        // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
                        $this->xml_encoding = 'ISO-8859-1';
                    }
                }
                $this->headers[$k] = $v;
                $this->request     .= "$k: $v\r\n";
                $this->debug("$k: $v");
            }
        } else {
            $this->debug('In parse_http_headers, HTTP headers not accessible');
            $this->setError('HTTP headers not accessible');
        }
    }

    /**
     * parses a request
     *
     * The following fields are set by this function (when successful)
     *
     * headers
     * request
     * xml_encoding
     * SOAPAction
     * request
     * requestSOAP
     * methodURI
     * methodname
     * methodparams
     * requestHeaders
     * document
     *
     * This sets the fault field on error
     *
     * @param string $data XML string
     */
    private function parse_request($data = '')
    {
        $this->debug('entering parse_request()');
        $this->parse_http_headers();
        $this->debug('got character encoding: ' . $this->xml_encoding);
        // uncompress if necessary
        if (isset($this->headers['content-encoding']) && '' !== $this->headers['content-encoding']) {
            $this->debug('got content encoding: ' . $this->headers['content-encoding']);
            if ('deflate' === $this->headers['content-encoding'] || 'gzip' === $this->headers['content-encoding']) {
                // if decoding works, use it. else assume data wasn't gzencoded
                if (function_exists('gzuncompress')) {
                    if ('deflate' === $this->headers['content-encoding'] && $degzdata = @gzuncompress($data)) {
                        $data = $degzdata;
                    } elseif ('gzip' === $this->headers['content-encoding'] && $degzdata = gzinflate(mb_substr($data, 10))) {
                        $data = $degzdata;
                    } else {
                        $this->fault('SOAP-ENV:Client', 'Errors occurred when trying to decode the data');

                        return;
                    }
                } else {
                    $this->fault('SOAP-ENV:Client', 'This Server does not support compressed data');

                    return;
                }
            }
        }
        $this->request     .= "\r\n" . $data;
        $data              = $this->parseRequest($this->headers, $data);
        $this->requestSOAP = $data;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->debug('leaving parse_request');
    }

    /**
     * invokes a PHP function for the requested SOAP method
     *
     * The following fields are set by this function (when successful)
     *
     * methodreturn
     *
     * Note that the PHP function that is called may also set the following
     * fields to affect the response sent to the client
     *
     * responseHeaders
     * outgoing_headers
     *
     * This sets the fault field on error
     */
    private function invoke_method()
    {
        $this->debug('in invoke_method, methodname=' . $this->methodname . ' methodURI=' . $this->methodURI . ' SOAPAction=' . $this->SOAPAction);

        //
        // if you are debugging in this area of the code, your service uses a class to implement methods,
        // you use SOAP RPC, and the client is .NET, please be aware of the following...
        // when the .NET wsdl.exe utility generates a proxy, it will remove the '.' or '..' from the
        // method name.  that is fine for naming the .NET methods.  it is not fine for properly constructing
        // the XML request and reading the XML response.  you need to add the RequestElementName and
        // ResponseElementName to the System.Web.Services.Protocols.SoapRpcMethodAttribute that wsdl.exe
        // generates for the method.  these parameters are used to specify the correct XML element names
        // for .NET to use, i.e. the names with the '.' in them.
        //
        $orig_methodname = $this->methodname;
        if ($this->wsdl) {
            if (false !== ($this->opData = $this->wsdl->getOperationData($this->methodname))) {

                $this->debug('in invoke_method, found WSDL operation=' . $this->methodname);
                $this->appendDebug('opData=' . $this->varDump($this->opData));
            } elseif (false !== ($this->opData = $this->wsdl->getOperationDataForSoapAction($this->SOAPAction))) {
                // Note: hopefully this case will only be used for doc/lit, since rpc services should have wrapper element
                $this->debug('in invoke_method, found WSDL soapAction=' . $this->SOAPAction . ' for operation=' . $this->opData['name']);
                $this->appendDebug('opData=' . $this->varDump($this->opData));
                $this->methodname = $this->opData['name'];
            } else {
                $this->debug('in invoke_method, no WSDL for operation=' . $this->methodname);
                $this->fault('SOAP-ENV:Client', "Operation '" . $this->methodname . "' is not defined in the WSDL for this service");

                return;
            }
        } else {
            $this->debug('in invoke_method, no WSDL to validate method');
        }

        // if a . is present in $this->methodname, we see if there is a class in scope,
        // which could be referred to. We will also distinguish between two deliminators,
        // to allow methods to be called a the class or an instance
        $delim = '';
        if (mb_strpos($this->methodname, '..') > 0) {
            $delim = '..';
        } elseif (mb_strpos($this->methodname, '.') > 0) {
            $delim = '.';
        }
        $this->debug("in invoke_method, delim=$delim");

        $class  = '';
        $method = '';
        if (mb_strlen($delim) > 0 && 1 == mb_substr_count($this->methodname, $delim)) {
            $try_class = mb_substr($this->methodname, 0, mb_strpos($this->methodname, $delim));
            if (class_exists($try_class)) {
                // get the class and method name
                $class  = $try_class;
                $method = mb_substr($this->methodname, mb_strpos($this->methodname, $delim) + mb_strlen($delim));
                $this->debug("in invoke_method, class=$class method=$method delim=$delim");
            } else {
                $this->debug("in invoke_method, class=$try_class not found");
            }
        } elseif (mb_strlen($delim) > 0 && mb_substr_count($this->methodname, $delim) > 1) {
            $split  = explode($delim, $this->methodname);
            $method = array_pop($split);
            $class  = implode('\\', $split);
        } else {
            $try_class = '';
            $this->debug('in invoke_method, no class to try');
        }

        // does method exist?
        if ('' === $class) {
            if (!function_exists($this->methodname)) {
                $this->debug("in invoke_method, function '$this->methodname' not found!");
                $this->result = 'fault: method not found';
                $this->fault('SOAP-ENV:Client', "method '$this->methodname'('$orig_methodname') not defined in service('$try_class' '$delim')");


                return;
            }
        } else {
            $method_to_compare = (0 === mb_strpos(PHP_VERSION, '4.')) ? mb_strtolower($method) : $method;
            if (!in_array($method_to_compare, get_class_methods($class))) {
                $this->debug("in invoke_method, method '$this->methodname' not found in class '$class'!");
                $this->result = 'fault: method not found';
                $this->fault('SOAP-ENV:Client', "method '$this->methodname'/'$method_to_compare'('$orig_methodname') not defined in service/'$class'('$try_class' '$delim')");

                return;
            }
        }

        // evaluate message, getting back parameters
        // verify that request parameters match the method's signature
        if (!$this->verify_method($this->methodname, $this->methodparams)) {
            // debug
            $this->debug('ERROR: request not verified against method signature');
            $this->result = 'fault: request failed validation against method signature';
            // return fault
            $this->fault('SOAP-ENV:Client', "Operation '$this->methodname' not defined in service.");

            return;
        }

        // if there are parameters to pass
        $this->debug('in invoke_method, params:');
        $this->appendDebug($this->varDump($this->methodparams));
        $this->debug("in invoke_method, calling '$this->methodname'");
        if (!function_exists('call_user_func_array')) {
            if ('' === $class) {
                $this->debug('in invoke_method, calling function using eval()');
                $funcCall = "\$this->methodreturn = $this->methodname(";
            } else {
                if ('..' === $delim) {
                    $this->debug('in invoke_method, calling class method using eval()');
                    $funcCall = '$this->methodreturn = ' . $class . '::' . $method . '(';
                } else {
                    $this->debug('in invoke_method, calling instance method using eval()');
                    // generate unique instance name
                    $instname = '$inst_' . time();
                    $funcCall = $instname . ' = new ' . $class . '(); ';
                    $funcCall .= '$this->methodreturn = ' . $instname . '->' . $method . '(';
                }
            }
            if ($this->methodparams) {

                foreach ($this->methodparams as $param) {
                    if (is_array($param) || is_object($param)) {
                        $this->fault('SOAP-ENV:Client', 'NuSOAP does not handle complexType parameters correctly when using eval; call_user_func_array must be available');

                        return;
                    }
                    $funcCall .= "\"$param\",";
                }
                $funcCall = mb_substr($funcCall, 0, -1);
            }
            $funcCall .= ');';
            $this->debug('in invoke_method, function call: ' . $funcCall);
            @eval($funcCall);

        } else {
            if ('' === $class) {
                $this->debug('in invoke_method, calling function using call_user_func_array()');
                $call_arg = $this->methodname;    // straight assignment changes $this->methodname to lower case after call_user_func_array()
            } elseif ('..' === $delim) {
                $this->debug('in invoke_method, calling class method using call_user_func_array()');
                $call_arg = [$class, $method];
            } else {
                $this->debug('in invoke_method, calling instance method using call_user_func_array()');
                $instance = new $class();
                $call_arg = [&$instance, $method];
            }
            if (is_array($this->methodparams)) {

                $this->methodreturn = call_user_func_array($call_arg, array_values($this->methodparams));
            } else {
                $this->methodreturn = call_user_func_array($call_arg, []);
            }
        }
        $this->debug('in invoke_method, methodreturn:');
        $this->appendDebug($this->varDump($this->methodreturn));
        $this->debug("in invoke_method, called method $this->methodname, received data of type " . gettype($this->methodreturn));
    }

    /**
     * serializes the return value from a PHP function into a full SOAP Envelope
     *
     * The following fields are set by this function (when successful)
     *
     * responseSOAP
     *
     * This sets the fault field on error
     */
    private function serialize_return()
    {
        $this->debug('Entering serialize_return methodname: ' . $this->methodname . ' methodURI: ' . $this->methodURI);
        // if fault
        if (isset($this->methodreturn) && is_object($this->methodreturn) && (('Soap_fault' === get_class($this->methodreturn)) || ('Nusoap_fault' === get_class($this->methodreturn)))) {
            $this->debug('got a fault object from method');
            $this->fault = $this->methodreturn;

            return;
        }

        if ($this->methodreturnisliteralxml) {
            $return_val = $this->methodreturn;
            // returned value(s)
        } else {
            $this->debug('got a(n) ' . gettype($this->methodreturn) . ' from method');
            $this->debug('serializing return value');
            if ($this->wsdl) {
                if (is_array($this->opData['output']['parts']) && count($this->opData['output']['parts']) > 1) {
                    $this->debug('more than one output part, so use the method return unchanged');
                    $opParams = $this->methodreturn;
                } elseif (1 == count($this->opData['output']['parts'])) {
                    $this->debug('exactly one output part, so wrap the method return in a simple array');
                    // TODO: verify that it is not already wrapped!
                    //foreach ($this->opData['output']['parts'] as $name => $type) {
                    //  $this->debug('wrap in element named ' . $name);
                    //}
                    $opParams = [$this->methodreturn];
                }
                $return_val = $this->wsdl->serializeRPCParameters($this->methodname, 'output', $opParams);

                $this->appendDebug($this->wsdl->getDebug());
                $this->wsdl->clearDebug();
                if (false !== ($errstr = $this->wsdl->getError())) {
                    $this->debug('got wsdl error: ' . $errstr);
                    $this->fault('SOAP-ENV:Server', 'unable to serialize result');

                    return;
                }
            } else {
                if (isset($this->methodreturn)) {
                    $return_val = $this->serialize_val($this->methodreturn, 'return');
                } else {
                    $return_val = '';
                    $this->debug('in absence of WSDL, assume void return for backward compatibility');
                }
            }
        }
        $this->debug('return value:');
        $this->appendDebug($this->varDump($return_val));

        $this->debug('serializing response');
        if ($this->wsdl) {
            $this->debug('have WSDL for serialization: style is ' . $this->opData['style']);
            if ('rpc' === $this->opData['style']) {
                $this->debug('style is rpc for serialization: use is ' . $this->opData['output']['use']);
                if ('literal' === $this->opData['output']['use']) {
                    // http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html R2735 says rpc/literal accessor elements should not be in a namespace
                    if ($this->methodURI) {
                        $payload = '<ns1:' . $this->methodname . 'Response xmlns:ns1="' . $this->methodURI . '">' . $return_val . '</ns1:' . $this->methodname . 'Response>';
                    } else {
                        $payload = '<' . $this->methodname . 'Response>' . $return_val . '</' . $this->methodname . 'Response>';
                    }
                } else {
                    if ($this->methodURI) {
                        $payload = '<ns1:' . $this->methodname . 'Response xmlns:ns1="' . $this->methodURI . '">' . $return_val . '</ns1:' . $this->methodname . 'Response>';
                    } else {
                        $payload = '<' . $this->methodname . 'Response>' . $return_val . '</' . $this->methodname . 'Response>';
                    }
                }
            } else {
                $this->debug('style is not rpc for serialization: assume document');
                $payload = $return_val;
            }
        } else {
            $this->debug('do not have WSDL for serialization: assume rpc/encoded');
            $payload = '<ns1:' . $this->methodname . 'Response xmlns:ns1="' . $this->methodURI . '">' . $return_val . '</ns1:' . $this->methodname . 'Response>';
        }
        $this->result = 'successful';
        if ($this->wsdl) {
            //if ($this->debug_flag) {
            $this->appendDebug($this->wsdl->getDebug());
            //  }
            $encodingStyle = '';
            if (isset($this->opData['output']['encodingStyle'])) {
                $encodingStyle = $this->opData['output']['encodingStyle'];
            }
            // Added: In case we use a WSDL, return a serialized env. WITH the usedNamespaces.
            $this->responseSOAP = $this->serializeEnvelope($payload, $this->responseHeaders, $this->wsdl->usedNamespaces, $this->opData['style'], $this->opData['output']['use'], $encodingStyle);
        } else {
            $this->responseSOAP = $this->serializeEnvelope($payload, $this->responseHeaders);
        }
        $this->debug('Leaving serialize_return');
    }

    /**
     * sends an HTTP response
     *
     * The following fields are set by this function (when successful)
     *
     * outgoing_headers
     * response
     */
    private function send_response()
    {
        $this->debug('Enter send_response');
        if ($this->fault) {
            $payload                  = $this->fault->serialize();
            $this->outgoing_headers[] = 'HTTP/1.0 500 Internal Server Error';
            $this->outgoing_headers[] = 'Status: 500 Internal Server Error';
        } else {
            $payload = $this->responseSOAP;
            // Some combinations of PHP+Web server allow the Status
            // to come through as a header.  Since OK is the default
            // just do nothing.
            // $this->outgoing_headers[] = "HTTP/1.0 200 OK";
            // $this->outgoing_headers[] = "Status: 200 OK";
        }
        // add debug data if in debug mode
        if (isset($this->debug_flag) && $this->debug_flag) {
            $payload .= $this->getDebugAsXMLComment();
        }
        $this->outgoing_headers[] = "Server: $this->title Server v$this->version";
        preg_match('/\$Revisio' . 'n: ([^ ]+)/', $this->revision, $rev);
        $this->outgoing_headers[] = "X-SOAP-Server: $this->title/$this->version (" . $rev[1] . ')';
        // Let the Web server decide about this
        //$this->outgoing_headers[] = "Connection: Close\r\n";
        $payload                  = $this->getHTTPBody($payload);
        $type                     = $this->getHTTPContentType();
        $charset                  = $this->getHTTPContentTypeCharset();
        $this->outgoing_headers[] = "Content-Type: $type" . ($charset ? '; charset=' . $charset : '');
        //begin code to compress payload - by John
        // NOTE: there is no way to know whether the Web server will also compress
        // this data.
        if (mb_strlen($payload) > 1024 && isset($this->headers) && isset($this->headers['accept-encoding'])) {
            if (false !== mb_strpos($this->headers['accept-encoding'], 'gzip')) {
                if (function_exists('gzencode')) {
                    if (isset($this->debug_flag) && $this->debug_flag) {
                        $payload .= '<!-- Content being gzipped -->';
                    }
                    $this->outgoing_headers[] = 'Content-Encoding: gzip';
                    $payload                  = gzencode($payload);
                } else {
                    if (isset($this->debug_flag) && $this->debug_flag) {
                        $payload .= '<!-- Content will not be gzipped: no gzencode -->';
                    }
                }
            } elseif (false !== mb_strpos($this->headers['accept-encoding'], 'deflate')) {
                // Note: MSIE requires gzdeflate output (no Zlib header and checksum),
                // instead of gzcompress output,
                // which conflicts with HTTP 1.1 spec (http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.5)
                if (function_exists('gzdeflate')) {
                    if (isset($this->debug_flag) && $this->debug_flag) {
                        $payload .= '<!-- Content being deflated -->';
                    }
                    $this->outgoing_headers[] = 'Content-Encoding: deflate';
                    $payload                  = gzdeflate($payload);
                } else {
                    if (isset($this->debug_flag) && $this->debug_flag) {
                        $payload .= '<!-- Content will not be deflated: no gzcompress -->';
                    }
                }
            }
        }
        //end code
        $this->outgoing_headers[] = 'Content-Length: ' . mb_strlen($payload);
        reset($this->outgoing_headers);
        foreach ($this->outgoing_headers as $hdr) {
            header($hdr, false);
        }
        print $payload;
        $this->response = implode("\r\n", $this->outgoing_headers) . "\r\n\r\n" . $payload;
    }

    /**
     * takes the value that was created by parsing the request
     * and compares to the method's signature, if available.
     *
     * @param  string $operation The operation to be invoked
     * @param  array  $request   The array of parameter values
     * @return bool Whether the operation was found
     */
    private function verify_method($operation, $request)
    private function verify_method($operation, /** @scrutinizer ignore-unused */ $request)
    {
        if (isset($this->wsdl) && is_object($this->wsdl)) {
            if ($this->wsdl->getOperationData($operation)) {
                return true;
            }
        } elseif (isset($this->operations[$operation])) {
            return true;
        }

        return false;
    }

    /**
     * processes SOAP message received from client
     *
     * @param  array  $headers The HTTP headers
     * @param  string $data    unprocessed request data from client
     * @return mixed  value of the message, decoded into a PHP type
     */
    private function parseRequest($headers, $data)
    {
        $this->debug('Entering parseRequest() for data of length ' . mb_strlen($data) . ' headers:');
        $this->appendDebug($this->varDump($headers));
        if (!isset($headers['content-type'])) {
            $this->setError('Request not of type text/xml (no content-type header)');

            return false;
        }
        if (false === mb_strpos($headers['content-type'], 'text/xml')) {
            $this->setError('Request not of type text/xml');

            return false;
        }
        if (mb_strpos($headers['content-type'], '=')) {
            $enc = str_replace('"', '', mb_substr(mb_strstr($headers['content-type'], '='), 1));
            $this->debug('Got response encoding: ' . $enc);
            $this->xml_encoding = 'US-ASCII';
            if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
                $this->xml_encoding = mb_strtoupper($enc);
            }
        } else {
            // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
            $this->xml_encoding = 'ISO-8859-1';
        }
        $this->debug('Use encoding: ' . $this->xml_encoding . ' when creating nusoap_parser');
        // parse response, get soap parser obj
        $parser = new Nusoap_parser($data, $this->xml_encoding, '', $this->decode_utf8);
        // parser debug
        $this->debug("parser debug: \n" . $parser->getDebug());
        // if fault occurred during message parsing
        if (false !== ($err = $parser->getError())) {
            $this->result = 'fault: error in msg parsing: ' . $err;
            $this->fault('SOAP-ENV:Client', "error in msg parsing:\n" . $err);
            // else successfully parsed request into soapval object
        } else {
            // get/set methodname
            $this->methodURI  = $parser->root_struct_namespace;
            $this->methodname = $parser->root_struct_name;
            $this->debug('methodname: ' . $this->methodname . ' methodURI: ' . $this->methodURI);
            $this->debug('calling parser->get_soapbody()');
            $this->methodparams = $parser->get_soapbody();
            // get SOAP headers
            $this->requestHeaders = $parser->getHeaders();
            // get SOAP Header
            $this->requestHeader = $parser->get_soapheader();
            // add document for doclit support
            $this->document = $parser->document;
        }
    }

    /**
     * gets the HTTP body for the current response.
     *
     * @param  string $soapmsg The SOAP payload
     * @return string The HTTP body, which includes the SOAP payload
     */
    private function getHTTPBody($soapmsg)
    {
        return $soapmsg;
    }

    /**
     * gets the HTTP content type for the current response.
     *
     * Note: getHTTPBody must be called before this.
     *
     * @return string the HTTP content type for the current response.
     */
    private function getHTTPContentType()
    {
        return 'text/xml';
    }

    /**
     * gets the HTTP content type charset for the current response.
     * returns false for non-text content types.
     *
     * Note: getHTTPBody must be called before this.
     *
     * @return string the HTTP content type charset for the current response.
     */
    private function getHTTPContentTypeCharset()
    {
        return $this->soap_defencoding;
    }

    /**
     * add a method to the dispatch map (this has been replaced by the register method)
     *
     * @param string $methodname
     * @param string $in  array of input values
     * @param string $out array of output values
     * @deprecated
     */
    public function add_to_map($methodname, $in, $out)
    {
        $this->operations[$methodname] = ['name' => $methodname, 'in' => $in, 'out' => $out];
    }

    /**
     * register a service function with the server
     *
     * @param string $name          the name of the PHP function, class.method or class..method
     * @param array  $in            assoc array of input values: key = param name, value = param type
     * @param array  $out           assoc array of output values: key = param name, value = param type
     * @param mixed  $namespace     the element namespace for the method or false
     * @param mixed  $soapaction    the soapaction for the method or false
     * @param mixed  $style         optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically
     * @param mixed  $use           optional (encoded|literal) or false
     * @param string $documentation optional Description to include in WSDL
     * @param string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)
     * @return bool
     */
    public function register(
        $name,
        $in = [],
        $out = [],
        $namespace = false,
        $soapaction = false,
        $style = false,
        $use = false,
        $documentation = '',
        $encodingStyle = '')
    {
        global $HTTP_SERVER_VARS;

        if ($this->externalWSDLURL) {
            die('You cannot bind to an external WSDL file, and register methods outside of it! Please choose either WSDL or no WSDL.');

        }
        if (!$name) {
            die('You must specify a name when you register an operation');

        }
        if (!is_array($in)) {

            die('You must provide an array for operation inputs');

        }
        if (!is_array($out)) {

            die('You must provide an array for operation outputs');

        }
        if (false === $namespace) {
        }
        if (false === $soapaction) {
            if (isset($_SERVER)) {
                $SERVER_NAME = $_SERVER['SERVER_NAME'];
                $SCRIPT_NAME = isset($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
                $HTTPS       = isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : (isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off');
            } elseif (isset($HTTP_SERVER_VARS)) {
                $SERVER_NAME = $HTTP_SERVER_VARS['SERVER_NAME'];
                $SCRIPT_NAME = isset($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
                $HTTPS       = isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off';
            } else {
                $this->setError('Neither _SERVER nor HTTP_SERVER_VARS is available');
            }
            $SCHEME = 'http';
            if ('1' == $HTTPS || 'on' === $HTTPS) {

                $SCHEME = 'https';
            }
            $soapaction = "$SCHEME://$SERVER_NAME$SCRIPT_NAME/$name";

        }
        if (false === $style) {
            $style = 'rpc';
        }
        if (false === $use) {
            $use = 'encoded';
        }
        if ('encoded' === $use && '' === $encodingStyle) {
            $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        }

        $this->operations[$name] = [
            'name'       => $name,
            'in'         => $in,
            'out'        => $out,
            'namespace'  => $namespace,
            'soapaction' => $soapaction,
            'style'      => $style,
        ];
        if ($this->wsdl) {
            $this->wsdl->addOperation($name, $in, $out, $namespace, $soapaction, $style, $use, $documentation, $encodingStyle);
        }

        return true;
    }

    /**
     * Specify a fault to be returned to the client.
     * This also acts as a flag to the server that a fault has occured.
     *
     * @param string $faultcode
     * @param string $faultstring
     * @param string $faultactor
     * @param string $faultdetail
     */
    public function fault($faultcode, $faultstring, $faultactor = '', $faultdetail = '')
    {
        if ('' === $faultdetail && $this->debug_flag) {
            $faultdetail = $this->getDebug();
        }
        $this->fault                   = new Nusoap_fault($faultcode, $faultactor, $faultstring, $faultdetail);
        $this->fault->soap_defencoding = $this->soap_defencoding;
    }

    /**
     * Sets up wsdl object.
     * Acts as a flag to enable internal WSDL generation
     *
     * @param string $serviceName           , name of the service
     * @param mixed  $namespace             optional 'tns' service namespace or false
     * @param mixed  $endpoint              optional URL of service endpoint or false
     * @param string $style                 optional (rpc|document) WSDL style (also specified by operation)
     * @param string $transport             optional SOAP transport
     * @param mixed  $schemaTargetNamespace optional 'types' targetNamespace for service schema or false
     */
    public function configureWSDL(
        $serviceName,
        $namespace = false,
        $endpoint = false,
        $style = 'rpc',
        $transport = 'http://schemas.xmlsoap.org/soap/http',
        $schemaTargetNamespace = false)
    {
        global $HTTP_SERVER_VARS;

        if (isset($_SERVER)) {
            $SERVER_NAME = $_SERVER['SERVER_NAME'];
            $SERVER_PORT = $_SERVER['SERVER_PORT'];
            $SCRIPT_NAME = isset($_SERVER['PHP_SELF']) ? $_SERVER['PHP_SELF'] : $_SERVER['SCRIPT_NAME'];
            $HTTPS       = isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : (isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off');
        } elseif (isset($HTTP_SERVER_VARS)) {
            $SERVER_NAME = $HTTP_SERVER_VARS['SERVER_NAME'];
            $SERVER_PORT = $HTTP_SERVER_VARS['SERVER_PORT'];
            $SCRIPT_NAME = isset($HTTP_SERVER_VARS['PHP_SELF']) ? $HTTP_SERVER_VARS['PHP_SELF'] : $HTTP_SERVER_VARS['SCRIPT_NAME'];
            $HTTPS       = isset($HTTP_SERVER_VARS['HTTPS']) ? $HTTP_SERVER_VARS['HTTPS'] : 'off';
        } else {
            $this->setError('Neither _SERVER nor HTTP_SERVER_VARS is available');
        }
        // If server name has port number attached then strip it (else port number gets duplicated in WSDL output) (occurred using lighttpd and FastCGI)
        $colon = mb_strpos($SERVER_NAME, ':');

        if ($colon) {
            $SERVER_NAME = mb_substr($SERVER_NAME, 0, $colon);
        }
        if (80 == $SERVER_PORT) {

            $SERVER_PORT = '';
        } else {
            $SERVER_PORT = ':' . $SERVER_PORT;
        }
        if (false === $namespace) {
            $namespace = "http://$SERVER_NAME/soap/$serviceName";
        }

        if (false === $endpoint) {
            $SCHEME = 'http';
            if ('1' == $HTTPS || 'on' === $HTTPS) {

                $SCHEME = 'https';
            }
            $endpoint = "$SCHEME://$SERVER_NAME$SERVER_PORT$SCRIPT_NAME";

        }

        if (false === $schemaTargetNamespace) {
            $schemaTargetNamespace = $namespace;
        }

        $this->wsdl                     = new Wsdl();
        $this->wsdl->serviceName        = $serviceName;

        $this->wsdl->endpoint           = $endpoint;
        $this->wsdl->namespaces['tns']  = $namespace;
        $this->wsdl->namespaces['soap'] = 'http://schemas.xmlsoap.org/wsdl/soap/';
        $this->wsdl->namespaces['Wsdl'] = 'http://schemas.xmlsoap.org/wsdl/';
        if ($schemaTargetNamespace != $namespace) {
            $this->wsdl->namespaces['types'] = $schemaTargetNamespace;
        }
        $this->wsdl->schemas[$schemaTargetNamespace][0] = new Nusoap_xmlschema('', '', $this->wsdl->namespaces);
        if ('document' === $style) {
            $this->wsdl->schemas[$schemaTargetNamespace][0]->schemaInfo['elementFormDefault'] = 'qualified';
        }
        $this->wsdl->schemas[$schemaTargetNamespace][0]->schemaTargetNamespace                                   = $schemaTargetNamespace;
        $this->wsdl->schemas[$schemaTargetNamespace][0]->imports['http://schemas.xmlsoap.org/soap/encoding/'][0] = [
            'location' => '',
            'loaded'   => true,
        ];
        $this->wsdl->schemas[$schemaTargetNamespace][0]->imports['http://schemas.xmlsoap.org/wsdl/'][0]          = [
            'location' => '',
            'loaded'   => true,
        ];
        $this->wsdl->bindings[$serviceName . 'Binding']                                                          = [
            'name'      => $serviceName . 'Binding',
            'style'     => $style,
            'transport' => $transport,
            'portType'  => $serviceName . 'PortType',
        ];
        $this->wsdl->ports[$serviceName . 'Port']                                                                = [
            'binding'     => $serviceName . 'Binding',
            'location'    => $endpoint,
            'bindingType' => 'http://schemas.xmlsoap.org/wsdl/soap/',
        ];
    }
}

/**
 * Backward compatibility
 */
class Soap_server extends Nusoap_server
{
}

/**
 * parses a WSDL file, allows access to it's data, other utility methods.
 * also builds WSDL structures programmatically.
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Wsdl extends Nusoap_base
{
    // URL or filename of the root of this WSDL
    public $wsdl;
    // define internal arrays of bindings, ports, operations, messages, etc.
    public $schemas       = [];
    public $currentSchema;
    public $message       = [];
    public $complexTypes  = [];
    public $messages      = [];
    public $currentMessage;
    public $currentOperation;
    public $portTypes     = [];
    public $currentPortType;
    public $bindings      = [];
    public $currentBinding;
    public $ports         = [];
    public $currentPort;
    public $opData        = [];
    public $status        = '';
    public $documentation = false;
    public $endpoint      = '';
    // array of wsdl docs to import
    public $import = [];
    // parser vars
    public $parser;
    public $position    = 0;
    public $depth       = 0;
    public $depth_array = [];
    // for getting wsdl
    public $proxyhost        = '';
    public $proxyport        = '';
    public $proxyusername    = '';
    public $proxypassword    = '';
    public $timeout          = 0;
    public $response_timeout = 30;
    public $curl_options     = [];    // User-specified cURL options
    public $use_curl         = false;            // whether to always try to use cURL
    // for HTTP authentication
    public $username    = '';                // Username for HTTP authentication
    public $password    = '';                // Password for HTTP authentication
    public $authtype    = '';                // Type of HTTP authentication
    public $certRequest = [];        // Certificate for HTTP SSL authentication

    /**
     * constructor
     *
     * @param string      $wsdl             WSDL document URL
     * @param bool|string $proxyhost
     * @param bool|string $proxyport
     * @param bool|string $proxyusername
     * @param bool|string $proxypassword
     * @param int         $timeout          set the connection timeout
     * @param int         $response_timeout set the response timeout
     * @param array       $curl_options     user-specified cURL options
     * @param bool        $use_curl         try to use cURL
     */
    public function __construct(
        $wsdl = '',
        $proxyhost = false,
        $proxyport = false,
        $proxyusername = false,
        $proxypassword = false,
        $timeout = 0,
        $response_timeout = 30,
        $curl_options = null,
        $use_curl = false)
    {
        parent::__construct();
        $this->debug("ctor wsdl=$wsdl timeout=$timeout response_timeout=$response_timeout");
        $this->proxyhost        = $proxyhost;
        $this->proxyport        = $proxyport;
        $this->proxyusername    = $proxyusername;
        $this->proxypassword    = $proxypassword;
        $this->timeout          = $timeout;
        $this->response_timeout = $response_timeout;
        if (is_array($curl_options)) {
            $this->curl_options = $curl_options;
        }
        $this->use_curl = $use_curl;
        $this->fetchWSDL($wsdl);
    }

    /**
     * fetches the WSDL document and parses it
     *
     * @param $wsdl
     */
    public function fetchWSDL($wsdl)
    {
        $this->debug("parse and process WSDL path=$wsdl");
        $this->wsdl = $wsdl;
        // parse wsdl file
        if ('' !== $this->wsdl) {
            $this->parseWSDL($this->wsdl);
        }
        // imports
        // TODO: handle imports more properly, grabbing them in-line and nesting them
        $imported_urls = [];
        $imported      = 1;
        while ($imported > 0) {
            $imported = 0;
            // Schema imports
            foreach ($this->schemas as $ns => $list) {
                foreach ($list as $xs) {
                    $wsdlparts = parse_url($this->wsdl);    // this is bogusly simple!
                    foreach ($xs->imports as $ns2 => $list2) {
                        for ($ii = 0, $iiMax = count($list2); $ii < $iiMax; ++$ii) {
                            if (!$list2[$ii]['loaded']) {
                                $this->schemas[$ns][$ns2]->imports[$ns2][$ii]['loaded'] = true;
                                $url                                                    = $list2[$ii]['location'];
                                if ('' !== $url) {
                                    $urlparts = parse_url($url);
                                    if (!isset($urlparts['host'])) {
                                        $url = $wsdlparts['scheme'] . '://' . $wsdlparts['host'] . (isset($wsdlparts['port']) ? ':' . $wsdlparts['port'] : '') . mb_substr($wsdlparts['path'], 0, mb_strrpos($wsdlparts['path'], '/') + 1) . $urlparts['path'];
                                    }
                                    if (!in_array($url, $imported_urls)) {
                                        $this->parseWSDL($url);
                                        ++$imported;
                                        $imported_urls[] = $url;
                                    }
                                } else {
                                    $this->debug('Unexpected scenario: empty URL for unloaded import');
                                }
                            }
                        }
                    }
                }
            }
            // WSDL imports
            $wsdlparts = parse_url($this->wsdl);    // this is bogusly simple!
            foreach ($this->import as $ns => $list) {
                for ($ii = 0, $iiMax = count($list); $ii < $iiMax; ++$ii) {
                    if (!$list[$ii]['loaded']) {
                        $this->import[$ns][$ii]['loaded'] = true;
                        $url                              = $list[$ii]['location'];
                        if ('' !== $url) {
                            $urlparts = parse_url($url);
                            if (!isset($urlparts['host'])) {
                                $url = $wsdlparts['scheme'] . '://' . $wsdlparts['host'] . (isset($wsdlparts['port']) ? ':' . $wsdlparts['port'] : '') . mb_substr($wsdlparts['path'], 0, mb_strrpos($wsdlparts['path'], '/') + 1) . $urlparts['path'];
                            }
                            if (!in_array($url, $imported_urls)) {
                                $this->parseWSDL($url);
                                ++$imported;
                                $imported_urls[] = $url;
                            }
                        } else {
                            $this->debug('Unexpected scenario: empty URL for unloaded import');
                        }
                    }
                }
            }
        }
        // add new data to operation data
        foreach ($this->bindings as $binding => $bindingData) {
            if (isset($bindingData['operations']) && is_array($bindingData['operations'])) {
                foreach ($bindingData['operations'] as $operation => $data) {
                    $this->debug('post-parse data gathering for ' . $operation);
                    $this->bindings[$binding]['operations'][$operation]['input']  = isset($this->bindings[$binding]['operations'][$operation]['input']) ? array_merge($this->bindings[$binding]['operations'][$operation]['input'],
                                                                                                                                                                      $this->portTypes[$bindingData['portType']][$operation]['input']) : $this->portTypes[$bindingData['portType']][$operation]['input'];
                    $this->bindings[$binding]['operations'][$operation]['output'] = isset($this->bindings[$binding]['operations'][$operation]['output']) ? array_merge($this->bindings[$binding]['operations'][$operation]['output'],
                                                                                                                                                                       $this->portTypes[$bindingData['portType']][$operation]['output']) : $this->portTypes[$bindingData['portType']][$operation]['output'];
                    if (isset($this->messages[$this->bindings[$binding]['operations'][$operation]['input']['message']])) {
                        $this->bindings[$binding]['operations'][$operation]['input']['parts'] = $this->messages[$this->bindings[$binding]['operations'][$operation]['input']['message']];
                    }
                    if (isset($this->messages[$this->bindings[$binding]['operations'][$operation]['output']['message']])) {
                        $this->bindings[$binding]['operations'][$operation]['output']['parts'] = $this->messages[$this->bindings[$binding]['operations'][$operation]['output']['message']];
                    }
                    // Set operation style if necessary, but do not override one already provided
                    if (isset($bindingData['style']) && !isset($this->bindings[$binding]['operations'][$operation]['style'])) {
                        $this->bindings[$binding]['operations'][$operation]['style'] = $bindingData['style'];
                    }
                    $this->bindings[$binding]['operations'][$operation]['transport']     = isset($bindingData['transport']) ? $bindingData['transport'] : '';
                    $this->bindings[$binding]['operations'][$operation]['documentation'] = isset($this->portTypes[$bindingData['portType']][$operation]['documentation']) ? $this->portTypes[$bindingData['portType']][$operation]['documentation'] : '';
                    $this->bindings[$binding]['operations'][$operation]['endpoint']      = isset($bindingData['endpoint']) ? $bindingData['endpoint'] : '';
                }
            }
        }
    }

    /**
     * parses the wsdl document
     *
     * @param string $wsdl path or URL
     * @return bool
     */
    private function parseWSDL($wsdl = '')
    {
        $this->debug("parse WSDL at path=$wsdl");

        if ('' === $wsdl) {
            $this->debug('no wsdl passed to parseWSDL()!!');
            $this->setError('no wsdl passed to parseWSDL()!!');

            return false;
        }

        // parse $wsdl for url format
        $wsdl_props = parse_url($wsdl);

        if (isset($wsdl_props['scheme']) && ('http' === $wsdl_props['scheme'] || 'https' === $wsdl_props['scheme'])) {
            $this->debug('getting WSDL http(s) URL ' . $wsdl);
            // get wsdl
            $tr                 = new Soap_transport_http($wsdl, $this->curl_options, $this->use_curl);
            $tr->request_method = 'GET';
            $tr->useSOAPAction  = false;
            if ($this->proxyhost && $this->proxyport) {
                $tr->setProxy($this->proxyhost, $this->proxyport, $this->proxyusername, $this->proxypassword);
            }
            if ('' !== $this->authtype) {
                $tr->setCredentials($this->username, $this->password, $this->authtype, [], $this->certRequest);
            }
            $tr->setEncoding('gzip, deflate');
            $wsdl_string = $tr->send('', $this->timeout, $this->response_timeout);
            //$this->debug("WSDL request\n" . $tr->outgoing_payload);
            //$this->debug("WSDL response\n" . $tr->incoming_payload);
            $this->appendDebug($tr->getDebug());
            // catch errors
            if (false !== ($err = $tr->getError())) {
                $errstr = 'Getting ' . $wsdl . ' - HTTP ERROR: ' . $err;
                $this->debug($errstr);
                $this->setError($errstr);
                unset($tr);

                return false;
            }
            unset($tr);
            $this->debug('got WSDL URL');
        } else {
            // $wsdl is not http(s), so treat it as a file URL or plain file path
            $path = $wsdl;
            if (isset($wsdl_props['scheme']) && ('file' === $wsdl_props['scheme']) && isset($wsdl_props['path'])) {
                $path = isset($wsdl_props['host']) ? ($wsdl_props['host'] . ':' . $wsdl_props['path']) : $wsdl_props['path'];
            }
            $this->debug('getting WSDL file ' . $path);
            if (false !== ($fp = @fopen($path, 'rb'))) {
                $wsdl_string = '';
                while (false !== ($data = fread($fp, 32768))) {
                    $wsdl_string .= $data;
                }
                fclose($fp);
            } else {
                $errstr = "Bad path to WSDL file $path";
                $this->debug($errstr);
                $this->setError($errstr);

                return false;
            }
        }
        $this->debug('Parse WSDL');
        // end new code added
        // Create an XML parser.
        $this->parser = xml_parser_create();
        // Set the options for parsing the XML data.
        // xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
        xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
        // Set the object for the parser.
        xml_set_object($this->parser, $this);
        // Set the element handlers for the parser.
        xml_set_element_handler($this->parser, 'start_element', 'end_element');
        xml_set_character_data_handler($this->parser, 'character_data');
        // Parse the XML file.
        if (!xml_parse($this->parser, $wsdl_string, true)) {
            // Display an error message.
            $errstr = sprintf('XML error parsing WSDL from %s on line %d: %s', $wsdl, xml_get_current_line_number($this->parser), xml_error_string(xml_get_error_code($this->parser)));
            $this->debug($errstr);
            $this->debug("XML payload:\n" . $wsdl_string);
            $this->setError($errstr);
            xml_parser_free($this->parser);
            unset($this->parser);

            return false;
        }
        // free the parser
        xml_parser_free($this->parser);
        unset($this->parser);
        $this->debug('Parsing WSDL done');
        // catch wsdl parse errors
        if ($this->getError()) {
            return false;
        }

        return true;
    }

    /**
     * start-element handler
     *
     * @param string       $parser XML parser object
     * @param string       $name   element name
     * @param string|array $attrs  associative array of attributes
     */
    private function start_element($parser, $name, $attrs)

    {
        if ('schema' === $this->status) {
            $this->currentSchema->schemaStartElement($parser, $name, $attrs);
            $this->appendDebug($this->currentSchema->getDebug());
            $this->currentSchema->clearDebug();
        } elseif (preg_match('/schema$/', $name)) {
            $this->debug('Parsing WSDL schema');
            // $this->debug("startElement for $name ($attrs[name]). status = $this->status (".$this->getLocalPart($name).")");
            $this->status        = 'schema';
            $this->currentSchema = new Nusoap_xmlschema('', '', $this->namespaces);
            $this->currentSchema->schemaStartElement($parser, $name, $attrs);
            $this->appendDebug($this->currentSchema->getDebug());
            $this->currentSchema->clearDebug();
        } else {
            // position in the total number of elements, starting from 0
            $pos   = $this->position++;
            $depth = $this->depth++;
            // set self as current value for this depth
            $this->depth_array[$depth] = $pos;
            $this->message[$pos]       = ['cdata' => ''];
            // process attributes
            if ($attrs && is_array($attrs)) {
                // register namespace declarations
                foreach ($attrs as $k => $v) {
                    if (preg_match('/^xmlns/', $k)) {
                        if (false !== ($ns_prefix = mb_substr(mb_strrchr($k, ':'), 1))) {
                            $this->namespaces[$ns_prefix] = $v;
                        } else {
                            $this->namespaces['ns' . (count($this->namespaces) + 1)] = $v;
                        }
                        if ('http://www.w3.org/2001/XMLSchema' === $v || 'http://www.w3.org/1999/XMLSchema' === $v || 'http://www.w3.org/2000/10/XMLSchema' === $v) {
                            $this->XMLSchemaVersion  = $v;
                            $this->namespaces['xsi'] = $v . '-instance';
                        }
                    }
                }
                // expand each attribute prefix to its namespace
                foreach ($attrs as $k => $v) {
                    $k = mb_strpos($k, ':') ? $this->expandQname($k) : $k;
                    if ('location' !== $k && 'soapAction' !== $k && 'namespace' !== $k) {
                        $v = mb_strpos($v, ':') ? $this->expandQname($v) : $v;
                    }
                    $eAttrs[$k] = $v;
                }
                $attrs = $eAttrs;

            } else {
                $attrs = [];
            }
            // Set default prefix and namespace
            // to prevent error Undefined variable $prefix and $namespace if (preg_match('/:/', $name)) return 0 or FALSE
            $prefix    = '';
            $namespace = '';
            // get element prefix, namespace and name
            if (preg_match('/:/', $name)) {
                // get ns prefix
                $prefix = mb_substr($name, 0, mb_strpos($name, ':'));
                // get ns
                $namespace = isset($this->namespaces[$prefix]) ? $this->namespaces[$prefix] : '';
                // get unqualified name
                $name = mb_substr(mb_strstr($name, ':'), 1);
            }
            // process attributes, expanding any prefixes to namespaces
            // find status, register data
            switch ($this->status) {
                case 'message':

                    if ('part' === $name) {
                        if (isset($attrs['type'])) {
                            $this->debug('msg ' . $this->currentMessage . ": found part (with type) $attrs[name]: " . implode(',', $attrs));
                            $this->messages[$this->currentMessage][$attrs['name']] = $attrs['type'];
                        }
                        if (isset($attrs['element'])) {
                            $this->debug('msg ' . $this->currentMessage . ": found part (with element) $attrs[name]: " . implode(',', $attrs));
                            $this->messages[$this->currentMessage][$attrs['name']] = $attrs['element'] . '^';
                        }
                    }

                    break;
                case 'portType':

                    switch ($name) {
                        case 'operation':

                            $this->currentPortOperation = $attrs['name'];

                            $this->debug("portType $this->currentPortType operation: $this->currentPortOperation");
                            if (isset($attrs['parameterOrder'])) {
                                $this->portTypes[$this->currentPortType][$attrs['name']]['parameterOrder'] = $attrs['parameterOrder'];
                            }

                            break;
                        case 'documentation':

                            $this->documentation = true;

                            break;
                        // merge input/output data
                        default:

                            $m                                                                                      = isset($attrs['message']) ? $this->getLocalPart($attrs['message']) : '';
                            $this->portTypes[$this->currentPortType][$this->currentPortOperation][$name]['message'] = $m;

                            break;
                    }

                    break;
                case 'binding':

                    switch ($name) {
                        case 'binding':
                            // get ns prefix

                            if (isset($attrs['style'])) {
                                $this->bindings[$this->currentBinding]['prefix'] = $prefix;
                            }
                            $this->bindings[$this->currentBinding] = array_merge($this->bindings[$this->currentBinding], $attrs);

                            break;
                        case 'header':

                            $this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus]['headers'][] = $attrs;

                            break;
                        case 'operation':

                            if (isset($attrs['soapAction'])) {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['soapAction'] = $attrs['soapAction'];
                            }
                            if (isset($attrs['style'])) {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['style'] = $attrs['style'];
                            }
                            if (isset($attrs['name'])) {
                                $this->currentOperation = $attrs['name'];
                                $this->debug("current binding operation: $this->currentOperation");
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['name']     = $attrs['name'];
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['binding']  = $this->currentBinding;
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['endpoint'] = isset($this->bindings[$this->currentBinding]['endpoint']) ? $this->bindings[$this->currentBinding]['endpoint'] : '';
                            }

                            break;
                        case 'input':

                            $this->opStatus = 'input';


                            break;
                        case 'output':

                            $this->opStatus = 'output';

                            break;
                        case 'body':

                            if (isset($this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus])) {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus] = array_merge($this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus], $attrs);
                            } else {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus] = $attrs;
                            }

                            break;
                    }

                    break;
                case 'service':

                    switch ($name) {
                        case 'port':

                            $this->currentPort = $attrs['name'];
                            $this->debug('current port: ' . $this->currentPort);
                            $this->ports[$this->currentPort]['binding'] = $this->getLocalPart($attrs['binding']);

                            break;
                        case 'address':

                            $this->ports[$this->currentPort]['location']                                = $attrs['location'];
                            $this->ports[$this->currentPort]['bindingType']                             = $namespace;
                            $this->bindings[$this->ports[$this->currentPort]['binding']]['bindingType'] = $namespace;
                            $this->bindings[$this->ports[$this->currentPort]['binding']]['endpoint']    = $attrs['location'];

                            break;
                    }

                    break;
            }
            // set status
            switch ($name) {
                case 'import':

                    if (isset($attrs['location'])) {
                        $this->import[$attrs['namespace']][] = ['location' => $attrs['location'], 'loaded' => false];
                        $this->debug('parsing import ' . $attrs['namespace'] . ' - ' . $attrs['location'] . ' (' . count($this->import[$attrs['namespace']]) . ')');
                    } else {
                        $this->import[$attrs['namespace']][] = ['location' => '', 'loaded' => true];
                        if (!$this->getPrefixFromNamespace($attrs['namespace'])) {
                            $this->namespaces['ns' . (count($this->namespaces) + 1)] = $attrs['namespace'];
                        }
                        $this->debug('parsing import ' . $attrs['namespace'] . ' - [no location] (' . count($this->import[$attrs['namespace']]) . ')');
                    }

                    break;
                //wait for schema
                //case 'types':
                //  $this->status = 'schema';
                //  break;
                case 'message':

                    $this->status                   = 'message';
                    $this->messages[$attrs['name']] = [];
                    $this->currentMessage           = $attrs['name'];

                    break;
                case 'portType':

                    $this->status                    = 'portType';
                    $this->portTypes[$attrs['name']] = [];
                    $this->currentPortType           = $attrs['name'];

                    break;
                case 'binding':

                    if (isset($attrs['name'])) {
                        // get binding name
                        if (mb_strpos($attrs['name'], ':')) {
                            $this->currentBinding = $this->getLocalPart($attrs['name']);
                        } else {
                            $this->currentBinding = $attrs['name'];
                        }
                        $this->status                                      = 'binding';
                        $this->bindings[$this->currentBinding]['portType'] = $this->getLocalPart($attrs['type']);
                        $this->debug("current binding: $this->currentBinding of portType: " . $attrs['type']);
                    }

                    break;
                case 'service':

                    $this->serviceName = $attrs['name'];

                    $this->status      = 'service';
                    $this->debug('current service: ' . $this->serviceName);

                    break;
                case 'definitions':

                    foreach ($attrs as $name => $value) {

                        $this->wsdl_info[$name] = $value;

                    }

                    break;
            }
        }
    }

    /**
     * end-element handler
     *
     * @param string $parser XML parser object
     * @param string $name   element name
     */
    private function end_element($parser, $name)

    {
        // unset schema status
        if (/*preg_match('/types$/', $name) ||*/
        preg_match('/schema$/', $name)) {
            $this->status = '';
            $this->appendDebug($this->currentSchema->getDebug());
            $this->currentSchema->clearDebug();
            $this->schemas[$this->currentSchema->schemaTargetNamespace][] = $this->currentSchema;
            $this->debug('Parsing WSDL schema done');
        }
        if ('schema' === $this->status) {
            $this->currentSchema->schemaEndElement($parser, $name);
        } else {
            // bring depth down a notch
            $this->depth--;
        }
        // end documentation
        if ($this->documentation) {
            //TODO: track the node to which documentation should be assigned; it can be a part, message, etc.
            //$this->portTypes[$this->currentPortType][$this->currentPortOperation]['documentation'] = $this->documentation;
            $this->documentation = false;
        }
    }

    /**
     * element content handler
     *
     * @param string $parser XML parser object
     * @param string $data   element content
     */
    private function character_data($parser, $data)
    private function character_data(/** @scrutinizer ignore-unused */ $parser, $data)
    {
        $pos = isset($this->depth_array[$this->depth]) ? $this->depth_array[$this->depth] : 0;
        if (isset($this->message[$pos]['cdata'])) {
            $this->message[$pos]['cdata'] .= $data;
        }
        if ($this->documentation) {
            $this->documentation .= $data;
        }
    }

    /**
     * if authenticating, set user credentials here
     *
     * @param string $username
     * @param string $password
     * @param string $authtype    (basic|digest|certificate|ntlm)
     * @param array  $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, certpassword (optional), verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)
     */
    public function setCredentials($username, $password, $authtype = 'basic', $certRequest = [])
    {
        $this->debug("setCredentials username=$username authtype=$authtype certRequest=");
        $this->appendDebug($this->varDump($certRequest));
        $this->username    = $username;
        $this->password    = $password;
        $this->authtype    = $authtype;
        $this->certRequest = $certRequest;
    }

    /**
     * @param $binding
     * @return mixed
     */
    public function getBindingData($binding)
    {
        if (is_array($this->bindings[$binding])) {
            return $this->bindings[$binding];
        }
    }

    /**
     * returns an assoc array of operation names => operation data
     *
     * @param  string $portName    WSDL port name
     * @param  string $bindingType eg: soap, smtp, dime (only soap and soap12 are currently supported)
     * @return array
     */
    public function getOperations($portName = '', $bindingType = 'soap')
    {
        $ops = [];
        if ('soap' === $bindingType) {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap/';
        } elseif ('soap12' === $bindingType) {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap12/';
        } else {
            $this->debug("getOperations bindingType $bindingType may not be supported");
        }
        $this->debug("getOperations for port '$portName' bindingType $bindingType");
        // loop thru ports
        foreach ($this->ports as $port => $portData) {
            $this->debug("getOperations checking port $port bindingType " . $portData['bindingType']);
            if ('' === $portName || $port == $portName) {
                // binding type of port matches parameter
                if ($portData['bindingType'] == $bindingType) {
                    $this->debug("getOperations found port $port bindingType $bindingType");
                    //$this->debug("port data: " . $this->varDump($portData));
                    //$this->debug("bindings: " . $this->varDump($this->bindings[ $portData['binding'] ]));
                    // merge bindings
                    if (isset($this->bindings[$portData['binding']]['operations'])) {
                        $ops = array_merge($ops, $this->bindings[$portData['binding']]['operations']);
                    }
                }
            }
        }
        if (0 === count($ops)) {
            $this->debug("getOperations found no operations for port '$portName' bindingType $bindingType");
        }

        return $ops;
    }

    /**
     * returns an associative array of data necessary for calling an operation
     *
     * @param  string $operation   name of operation
     * @param  string $bindingType type of binding eg: soap, soap12
     * @return array
     */
    public function getOperationData($operation, $bindingType = 'soap')
    {
        if ('soap' === $bindingType) {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap/';
        } elseif ('soap12' === $bindingType) {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap12/';
        }
        // loop thru ports
        foreach ($this->ports as $port => $portData) {
            // binding type of port matches parameter
            if ($portData['bindingType'] == $bindingType) {
                // get binding
                //foreach ($this->bindings[ $portData['binding'] ]['operations'] as $bOperation => $opData) {
                foreach (array_keys($this->bindings[$portData['binding']]['operations']) as $bOperation) {
                    // note that we could/should also check the namespace here
                    if ($operation == $bOperation) {
                        $opData = $this->bindings[$portData['binding']]['operations'][$operation];

                        return $opData;
                    }
                }
            }
        }
    }

    /**
     * returns an associative array of data necessary for calling an operation
     *
     * @param  string $soapAction  soapAction for operation
     * @param  string $bindingType type of binding eg: soap, soap12
     * @return array
     */
    public function getOperationDataForSoapAction($soapAction, $bindingType = 'soap')
    {
        if ('soap' === $bindingType) {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap/';
        } elseif ('soap12' === $bindingType) {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap12/';
        }
        // loop thru ports
        foreach ($this->ports as $port => $portData) {
            // binding type of port matches parameter
            if ($portData['bindingType'] == $bindingType) {
                // loop through operations for the binding
                foreach ($this->bindings[$portData['binding']]['operations'] as $bOperation => $opData) {
                    if ($opData['soapAction'] == $soapAction) {
                        return $opData;
                    }
                }
            }
        }
    }

    /**
     * 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
     *   )
     *
     * @param  string $type the type
     * @param  string $ns   namespace (not prefix) of the type
     * @return mixed
     * @see    nusoap_xmlschema
     */
    public function getTypeDef($type, $ns)
    {
        $this->debug("in getTypeDef: type=$type, ns=$ns");
        if ((!$ns) && isset($this->namespaces['tns'])) {
            $ns = $this->namespaces['tns'];
            $this->debug("in getTypeDef: type namespace forced to $ns");
        }
        if (!isset($this->schemas[$ns])) {
            foreach ($this->schemas as $ns0 => $schema0) {
                if (0 == strcasecmp($ns, $ns0)) {
                    $this->debug("in getTypeDef: replacing schema namespace $ns with $ns0");
                    $ns = $ns0;
                    break;
                }
            }
        }
        if (isset($this->schemas[$ns])) {
            $this->debug("in getTypeDef: have schema for namespace $ns");
            for ($i = 0, $iMax = count($this->schemas[$ns]); $i < $iMax; ++$i) {
                $xs = $this->schemas[$ns][$i];
                $t  = $xs->getTypeDef($type);
                $this->appendDebug($xs->getDebug());
                $xs->clearDebug();
                if ($t) {
                    $this->debug("in getTypeDef: found type $type");
                    if (!isset($t['phpType'])) {
                        // get info for type to tack onto the element
                        $uqType = mb_substr($t['type'], mb_strrpos($t['type'], ':') + 1);
                        $ns     = mb_substr($t['type'], 0, mb_strrpos($t['type'], ':'));
                        $etype  = $this->getTypeDef($uqType, $ns);
                        if ($etype) {
                            $this->debug("found type for [element] $type:");
                            $this->debug($this->varDump($etype));
                            if (isset($etype['phpType'])) {
                                $t['phpType'] = $etype['phpType'];
                            }
                            if (isset($etype['elements'])) {
                                $t['elements'] = $etype['elements'];
                            }
                            if (isset($etype['attrs'])) {
                                $t['attrs'] = $etype['attrs'];
                            }
                        } else {
                            $this->debug("did not find type for [element] $type");
                        }
                    }

                    return $t;
                }
            }
            $this->debug("in getTypeDef: did not find type $type");
        } else {
            $this->debug("in getTypeDef: do not have schema for namespace $ns");
        }

        return false;
    }

    /**
     * prints html description of services
     */
    public function webDescription()
    {
        global $HTTP_SERVER_VARS;

        if (isset($_SERVER)) {
            $PHP_SELF = $_SERVER['PHP_SELF'];
        } elseif (isset($HTTP_SERVER_VARS)) {
            $PHP_SELF = $HTTP_SERVER_VARS['PHP_SELF'];
        } else {
            $this->setError('Neither _SERVER nor HTTP_SERVER_VARS is available');
        }

        $b = '
        <html><head><title>NuSOAP: ' . $this->serviceName . '</title>
        <style type="text/css">
            body    { font-family: arial sans-serif; color: #000000; background-color: #ffffff; margin: 0px 0px 0px 0px; }
            p       { font-family: arial sans-serif; color: #000000; margin-top: 0px; margin-bottom: 12px; }
            pre { background-color: silver; padding: 5px; font-family: Courier New; font-size: x-small; color: #000000;}
            ul      { margin-top: 10px; margin-left: 20px; }
            li      { list-style-type: none; margin-top: 10px; color: #000000; }
            .content{
            margin-left: 0px; padding-bottom: 2em; }
            .nav {
            padding-top: 10px; padding-bottom: 10px; padding-left: 15px; font-size: .70em;
            margin-top: 10px; margin-left: 0px; color: #000000;
            background-color: #ccccff; width: 20%; margin-left: 20px; margin-top: 20px; }
            .title {
            font-family: arial sans-serif; font-size: 26px; color: #ffffff;
            background-color: #999999; width: 100%;
            margin-left: 0px; margin-right: 0px;
            padding-top: 10px; padding-bottom: 10px;}
            .hidden {
            position: absolute; visibility: hidden; z-index: 200; left: 250px; top: 100px;
            font-family: arial sans-serif; overflow: hidden; width: 600;
            padding: 20px; font-size: 10px; background-color: #999999;
            layer-background-color:#FFFFFF; }
            a,a:active  { color: charcoal; font-weight: bold; }
            a:visited   { color: #666666; font-weight: bold; }
            a:hover     { color: cc3300; font-weight: bold; }
        </style>
        <script language="JavaScript" type="text/javascript">
        <!--
        // POP-UP CAPTIONS...
        function lib_bwcheck(){ //Browsercheck (needed)
            this.ver=navigator.appVersion
            this.agent=navigator.userAgent
            this.dom=document.getElementById?1:0
            this.opera5=this.agent.indexOf("Opera 5")>-1
            this.ie5=(this.ver.indexOf("MSIE 5")>-1 && this.dom && !this.opera5)?1:0;
            this.ie6=(this.ver.indexOf("MSIE 6")>-1 && this.dom && !this.opera5)?1:0;
            this.ie4=(document.all && !this.dom && !this.opera5)?1:0;
            this.ie=this.ie4||this.ie5||this.ie6
            this.mac=this.agent.indexOf("Mac")>-1
            this.ns6=(this.dom && parseInt(this.ver) >= 5) ?1:0;
            this.ns4=(document.layers && !this.dom)?1:0;
            this.bw=(this.ie6 || this.ie5 || this.ie4 || this.ns4 || this.ns6 || this.opera5)

            return this
        }
        var bw = new Lib_bwcheck()
        //Makes crossbrowser object.
        function makeObj(obj){
            this.evnt=bw.dom? document.getElementById(obj):bw.ie4?document.all[obj]:bw.ns4?document.layers[obj]:0;
            if(!this.evnt) return false
            this.css=bw.dom||bw.ie4?this.evnt.style:bw.ns4?this.evnt:0;
            this.wref=bw.dom||bw.ie4?this.evnt:bw.ns4?this.css.document:0;
            this.writeIt=b_writeIt;

            return this
        }
        // A unit of measure that will be added when setting the position of a layer.
        //var px = bw.ns4||window.opera?"":"px";
        function b_writeIt(text){
            if (bw.ns4) {this.wref.write(text);this.wref.close()}
            else this.wref.innerHTML = text
        }
        //Shows the messages
        var oDesc;
        function popup(divid){
            if (oDesc = new MakeObj(divid)) {
            oDesc.css.visibility = "visible"
            }
        }
        function popout(){ // Hides message
            if(oDesc) oDesc.css.visibility = "hidden"
        }
        //-->
        </script>
        </head>
        <body>
        <div class=content>
            <br><br>
            <div class=title>' . $this->serviceName . '</div>
            <div class=nav>
                <p>View the <a href="' . $PHP_SELF . '?wsdl">WSDL</a> for the service.

                Click on an operation name to view it&apos;s details.</p>
                <ul>';
        foreach ($this->getOperations() as $op => $data) {
            $b .= "<li><a href='#' onclick=\"popout();popup('$op')\">$op</a></li>";
            // create hidden div
            $b .= "<div id='$op' class='hidden'>
                    <a href='#' onclick='popout()'><span style='color: #ffffff; '>Close</span></a><br><br>";
            foreach ($data as $donnie => $marie) {
                // loop through opdata
                if ('input' === $donnie || 'output' === $donnie) {
                    // show input/output data
                    $b .= "<font color='white'>" . ucfirst($donnie) . ':</font><br>';
                    foreach ($marie as $captain => $tenille) {
                        // loop through data
                        if ('parts' === $captain) {
                            // loop thru parts
                            $b .= "&nbsp;&nbsp;$captain:<br>";
                            //if (is_array($tenille)) {
                            foreach ($tenille as $joanie => $chachi) {
                                $b .= "&nbsp;&nbsp;&nbsp;&nbsp;$joanie: $chachi<br>";
                            }
                            //}
                        } else {
                            $b .= "&nbsp;&nbsp;$captain: $tenille<br>";
                        }
                    }
                } else {
                    $b .= "<font color='white'>" . ucfirst($donnie) . ":</font> $marie<br>";
                }
            }
            $b .= '</div>';
        }
        $b .= '
                <ul>
            </div>
        </div></body></html>';

        return $b;
    }

    /**
     * serialize the parsed wsdl
     *
     * @param  mixed $debug whether to put debug=1 in endpoint URL
     * @return string serialization of WSDL
     */
    public function serialize($debug = 0)
    {
        $xml = '<?xml version="1.0" encoding="ISO-8859-1"?>';
        $xml .= "\n<definitions";
        foreach ($this->namespaces as $k => $v) {
            $xml .= " xmlns:$k=\"$v\"";
        }
        // 10.9.02 - add poulter fix for wsdl and tns declarations
        if (isset($this->namespaces['wsdl'])) {
            $xml .= ' xmlns="' . $this->namespaces['wsdl'] . '"';
        }
        if (isset($this->namespaces['tns'])) {
            $xml .= ' targetNamespace="' . $this->namespaces['tns'] . '"';
        }
        $xml .= '>';
        // imports
        if ($this->import && is_array($this->import)) {

            foreach ($this->import as $ns => $list) {
                foreach ($list as $ii) {
                    if ('' !== $ii['location']) {
                        $xml .= '<import location="' . $ii['location'] . '" namespace="' . $ns . '">';
                    } else {
                        $xml .= '<import namespace="' . $ns . '">';
                    }
                }
            }
        }
        // types
        if (is_array($this->schemas) && count($this->schemas) >= 1) {
            $xml .= "\n<types>\n";
            foreach ($this->schemas as $ns => $list) {
                foreach ($list as $xs) {
                    $xml .= $xs->serializeSchema();
                }
            }
            $xml .= '</types>';
        }
        // messages
        if (is_array($this->messages) && count($this->messages) >= 1) {
            foreach ($this->messages as $msgName => $msgParts) {
                $xml .= "\n<message name=\"" . $msgName . '">';
                if (is_array($msgParts)) {
                    foreach ($msgParts as $partName => $partType) {
                        // print 'serializing '.$partType.', sv: '.$this->XMLSchemaVersion.'<br>';
                        if (mb_strpos($partType, ':')) {
                            $typePrefix = $this->getPrefixFromNamespace($this->getPrefix($partType));
                            $typePrefix = $this->getPrefixFromNamespace(/** @scrutinizer ignore-type */ $this->getPrefix($partType));
                        } elseif (isset($this->typemap[$this->namespaces['xsd']][$partType])) {
                            // print 'checking typemap: '.$this->XMLSchemaVersion.'<br>';
                            $typePrefix = 'xsd';
                        } else {
                            foreach ($this->typemap as $ns => $types) {
                                if (isset($types[$partType])) {
                                    $typePrefix = $this->getPrefixFromNamespace($ns);
                                }
                            }
                            if (!isset($typePrefix)) {
                                die("$partType has no namespace!");

                            }
                        }
                        $ns        = $this->getNamespaceFromPrefix($typePrefix);
                        $ns        = $this->getNamespaceFromPrefix(/** @scrutinizer ignore-type */ $typePrefix);
                        $localPart = $this->getLocalPart($partType);
                        $typeDef   = $this->getTypeDef($localPart, $ns);
                        $typeDef   = $this->getTypeDef($localPart, /** @scrutinizer ignore-type */ $ns);
                        if ('element' === $typeDef['typeClass']) {
                            $elementortype = 'element';
                            if ('^' === mb_substr($localPart, -1)) {
                                $localPart = mb_substr($localPart, 0, -1);
                            }
                        } else {
                            $elementortype = 'type';
                        }
                        $xml .= "\n" . '  <part name="' . $partName . '" ' . $elementortype . '="' . $typePrefix . ':' . $localPart . '">';
                        $xml .= "\n" . '  <part name="' . $partName . '" ' . $elementortype . '="' . /** @scrutinizer ignore-type */ $typePrefix . ':' . $localPart . '">';
                    }
                }
                $xml .= '</message>';
            }
        }
        // bindings & porttypes
        if (is_array($this->bindings) && count($this->bindings) >= 1) {
            $binding_xml  = '';
            $portType_xml = '';
            foreach ($this->bindings as $bindingName => $attrs) {
                $binding_xml  .= "\n<binding name=\"" . $bindingName . '" type="tns:' . $attrs['portType'] . '">';
                $binding_xml  .= "\n" . '  <soap:binding style="' . $attrs['style'] . '" transport="' . $attrs['transport'] . '">';
                $portType_xml .= "\n<portType name=\"" . $attrs['portType'] . '">';
                foreach ($attrs['operations'] as $opName => $opParts) {
                    $binding_xml .= "\n" . '  <operation name="' . $opName . '">';
                    $binding_xml .= "\n" . '    <soap:operation soapAction="' . $opParts['soapAction'] . '" style="' . $opParts['style'] . '">';
                    $enc_style   = '';
                    if (isset($opParts['input']['encodingStyle']) && '' !== $opParts['input']['encodingStyle']) {
                        $enc_style = ' encodingStyle="' . $opParts['input']['encodingStyle'] . '"';
                    }
                    $binding_xml .= "\n" . '    <input><soap:body use="' . $opParts['input']['use'] . '" namespace="' . $opParts['input']['namespace'] . '"' . $enc_style . '></input>';
                    $enc_style   = '';
                    if (isset($opParts['output']['encodingStyle']) && '' !== $opParts['output']['encodingStyle']) {
                        $enc_style = ' encodingStyle="' . $opParts['output']['encodingStyle'] . '"';
                    }
                    $binding_xml  .= "\n" . '    <output><soap:body use="' . $opParts['output']['use'] . '" namespace="' . $opParts['output']['namespace'] . '"' . $enc_style . '></output>';
                    $binding_xml  .= "\n" . '  </operation>';
                    $portType_xml .= "\n" . '  <operation name="' . $opParts['name'] . '"';
                    if (isset($opParts['parameterOrder'])) {
                        $portType_xml .= ' parameterOrder="' . $opParts['parameterOrder'] . '"';
                    }
                    $portType_xml .= '>';
                    if (isset($opParts['documentation']) && '' !== $opParts['documentation']) {
                        $portType_xml .= "\n" . '    <documentation>' . htmlspecialchars($opParts['documentation'], ENT_QUOTES | ENT_HTML5) . '</documentation>';
                    }
                    $portType_xml .= "\n" . '    <input message="tns:' . $opParts['input']['message'] . '">';
                    $portType_xml .= "\n" . '    <output message="tns:' . $opParts['output']['message'] . '">';
                    $portType_xml .= "\n" . '  </operation>';
                }
                $portType_xml .= "\n" . '</portType>';
                $binding_xml  .= "\n" . '</binding>';
            }
            $xml .= $portType_xml . $binding_xml;
        }
        // services
        $xml .= "\n<service name=\"" . $this->serviceName . '">';
        if (is_array($this->ports) && count($this->ports) >= 1) {
            foreach ($this->ports as $pName => $attrs) {
                $xml .= "\n" . '  <port name="' . $pName . '" binding="tns:' . $attrs['binding'] . '">';
                $xml .= "\n" . '    <soap:address location="' . $attrs['location'] . ($debug ? '?debug=1' : '') . '">';
                $xml .= "\n" . '  </port>';
            }
        }
        $xml .= "\n" . '</service>';

        return $xml . "\n</definitions>";
    }

    /**
     * determine whether a set of parameters are unwrapped
     * when they are expect to be wrapped, Microsoft-style.
     *
     * @param  string $type       the type (element name) of the wrapper
     * @param  array  $parameters the parameter values for the SOAP call
     * @return bool whether they parameters are unwrapped (and should be wrapped)
     */
    private function parametersMatchWrapped($type, &$parameters)
    {
        $this->debug("in parametersMatchWrapped type=$type, parameters=");
        $this->appendDebug($this->varDump($parameters));

        // split type into namespace:unqualified-type
        if (mb_strpos($type, ':')) {
            $uqType = mb_substr($type, mb_strrpos($type, ':') + 1);
            $ns     = mb_substr($type, 0, mb_strrpos($type, ':'));
            $this->debug("in parametersMatchWrapped: got a prefixed type: $uqType, $ns");
            if ($this->getNamespaceFromPrefix($ns)) {
                $ns = $this->getNamespaceFromPrefix($ns);
                $this->debug("in parametersMatchWrapped: expanded prefixed type: $uqType, $ns");
            }
        } else {
            // TODO: should the type be compared to types in XSD, and the namespace
            // set to XSD if the type matches?
            $this->debug("in parametersMatchWrapped: No namespace for type $type");
            $ns     = '';
            $uqType = $type;
        }

        // get the type information
        if (!$typeDef = $this->getTypeDef($uqType, $ns)) {
            $this->debug("in parametersMatchWrapped: $type ($uqType) is not a supported type.");

            return false;
        }
        $this->debug('in parametersMatchWrapped: found typeDef=');
        $this->appendDebug($this->varDump($typeDef));
        if ('^' === mb_substr($uqType, -1)) {
            $uqType = mb_substr($uqType, 0, -1);
        }
        $phpType   = $typeDef['phpType'];
        $arrayType = (isset($typeDef['arrayType']) ? $typeDef['arrayType'] : '');
        $this->debug("in parametersMatchWrapped: uqType: $uqType, ns: $ns, phptype: $phpType, arrayType: $arrayType");

        // we expect a complexType or element of complexType
        if ('struct' !== $phpType) {
            $this->debug('in parametersMatchWrapped: not a struct');

            return false;
        }

        // see whether the parameter names match the elements
        if (isset($typeDef['elements']) && is_array($typeDef['elements'])) {
            $elements = 0;
            $matches  = 0;
            foreach ($typeDef['elements'] as $name => $attrs) {
                if (isset($parameters[$name])) {
                    $this->debug("in parametersMatchWrapped: have parameter named $name");
                    ++$matches;
                } else {
                    $this->debug("in parametersMatchWrapped: do not have parameter named $name");
                }
                ++$elements;
            }

            $this->debug("in parametersMatchWrapped: $matches parameter names match $elements wrapped parameter names");

            return !(0 == $matches);
        }

        // since there are no elements for the type, if the user passed no
        // parameters, the parameters match wrapped.
        $this->debug("in parametersMatchWrapped: no elements type $ns:$uqType");

        return 0 === count($parameters);
    }

    /**
     * serialize PHP values according to a WSDL message definition
     * contrary to the method name, this is not limited to RPC
     *
     * TODO
     * - multi-ref serialization
     * - validate PHP values against type definitions, return errors if invalid
     *
     * @param  string $operation   operation name
     * @param  string $direction   (input|output)
     * @param  mixed  $parameters  parameter value(s)
     * @param  string $bindingType (soap|soap12)
     * @return mixed  parameters serialized as XML or false on error (e.g. operation not found)
     */
    public function serializeRPCParameters($operation, $direction, $parameters, $bindingType = 'soap')
    {
        $this->debug("in serializeRPCParameters: operation=$operation, direction=$direction, XMLSchemaVersion=$this->XMLSchemaVersion, bindingType=$bindingType");
        $this->appendDebug('parameters=' . $this->varDump($parameters));

        if ('input' !== $direction && 'output' !== $direction) {
            $this->debug('The value of the \$direction argument needs to be either "input" or "output"');
            $this->setError('The value of the \$direction argument needs to be either "input" or "output"');

            return false;
        }
        if (!$opData = $this->getOperationData($operation, $bindingType)) {
            $this->debug('Unable to retrieve WSDL data for operation: ' . $operation . ' bindingType: ' . $bindingType);
            $this->setError('Unable to retrieve WSDL data for operation: ' . $operation . ' bindingType: ' . $bindingType);

            return false;
        }
        $this->debug('in serializeRPCParameters: opData:');
        $this->appendDebug($this->varDump($opData));

        // Get encoding style for output and set to current
        $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        if (('input' === $direction) && isset($opData['output']['encodingStyle']) && ($opData['output']['encodingStyle'] != $encodingStyle)) {
            $encodingStyle = $opData['output']['encodingStyle'];
            $enc_style     = $encodingStyle;

        }

        // set input params
        $xml = '';
        if (isset($opData[$direction]['parts']) && count($opData[$direction]['parts']) > 0) {
            $parts      = &$opData[$direction]['parts'];
            $part_count = count($parts);
            $style      = $opData['style'];
            $use        = $opData[$direction]['use'];
            $this->debug("have $part_count part(s) to serialize using $style/$use");
            if (is_array($parameters)) {
                $parametersArrayType = $this->isArraySimpleOrStruct($parameters);
                $parameter_count     = count($parameters);
                $this->debug("have $parameter_count parameter(s) provided as $parametersArrayType to serialize");
                // check for Microsoft-style wrapped parameters
                if ('document' === $style && 'literal' === $use && 1 == $part_count && isset($parts['parameters'])) {
                    $this->debug('check whether the caller has wrapped the parameters');
                    if ('output' === $direction && 'arraySimple' === $parametersArrayType && 1 == $parameter_count) {
                        // TODO: consider checking here for double-wrapping, when
                        // service function wraps, then NuSOAP wraps again
                        $this->debug("change simple array to associative with 'parameters' element");
                        $parameters['parameters'] = $parameters[0];
                        unset($parameters[0]);
                    }
                    if (('arrayStruct' === $parametersArrayType || 0 == $parameter_count) && !isset($parameters['parameters'])) {
                        $this->debug('check whether caller\'s parameters match the wrapped ones');
                        if ($this->parametersMatchWrapped($parts['parameters'], $parameters)) {
                            $this->debug('wrap the parameters for the caller');
                            $parameters      = ['parameters' => $parameters];
                            $parameter_count = 1;

                        }
                    }
                }
                foreach ($parts as $name => $type) {
                    $this->debug("serializing part $name of type $type");
                    // Track encoding style
                    if (isset($opData[$direction]['encodingStyle']) && $encodingStyle != $opData[$direction]['encodingStyle']) {
                        $encodingStyle = $opData[$direction]['encodingStyle'];
                        $enc_style     = $encodingStyle;
                    } else {
                        $enc_style = false;
                    }
                    // NOTE: add error handling here
                    // if serializeType returns false, then catch global error and fault
                    if ('arraySimple' === $parametersArrayType) {
                        $p = array_shift($parameters);
                        $this->debug('calling serializeType w/indexed param');
                        $xml .= $this->serializeType($name, $type, $p, $use, $enc_style);
                    } elseif (isset($parameters[$name])) {
                        $this->debug('calling serializeType w/named param');
                        $xml .= $this->serializeType($name, $type, $parameters[$name], $use, $enc_style);
                    } else {
                        // TODO: only send nillable
                        $this->debug('calling serializeType w/null param');
                        $xml .= $this->serializeType($name, $type, null, $use, $enc_style);
                    }
                }
            } else {
                $this->debug('no parameters passed.');
            }
        }
        $this->debug("serializeRPCParameters returning: $xml");

        return $xml;
    }

    /**
     * serialize a PHP value according to a WSDL message definition
     *
     * TODO
     * - multi-ref serialization
     * - validate PHP values against type definitions, return errors if invalid
     *
     * @param  string $operation  operation name
     * @param  string $direction  (input|output)
     * @param  mixed  $parameters parameter value(s)
     * @return mixed  parameters serialized as XML or false on error (e.g. operation not found)
     * @deprecated
     */
    public function serializeParameters($operation, $direction, $parameters)
    {
        $this->debug("in serializeParameters: operation=$operation, direction=$direction, XMLSchemaVersion=$this->XMLSchemaVersion");
        $this->appendDebug('parameters=' . $this->varDump($parameters));

        if ('input' !== $direction && 'output' !== $direction) {
            $this->debug('The value of the \$direction argument needs to be either "input" or "output"');
            $this->setError('The value of the \$direction argument needs to be either "input" or "output"');

            return false;
        }
        if (!$opData = $this->getOperationData($operation)) {
            $this->debug('Unable to retrieve WSDL data for operation: ' . $operation);
            $this->setError('Unable to retrieve WSDL data for operation: ' . $operation);

            return false;
        }
        $this->debug('opData:');
        $this->appendDebug($this->varDump($opData));

        // Get encoding style for output and set to current
        $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        if (('input' === $direction) && isset($opData['output']['encodingStyle']) && ($opData['output']['encodingStyle'] != $encodingStyle)) {
            $encodingStyle = $opData['output']['encodingStyle'];
            $enc_style     = $encodingStyle;

        }

        // set input params
        $xml = '';
        if (isset($opData[$direction]['parts']) && count($opData[$direction]['parts']) > 0) {
            $use = $opData[$direction]['use'];
            $this->debug("use=$use");
            $this->debug('got ' . count($opData[$direction]['parts']) . ' part(s)');
            if (is_array($parameters)) {
                $parametersArrayType = $this->isArraySimpleOrStruct($parameters);
                $this->debug('have ' . $parametersArrayType . ' parameters');
                foreach ($opData[$direction]['parts'] as $name => $type) {
                    $this->debug('serializing part "' . $name . '" of type "' . $type . '"');
                    // Track encoding style
                    if (isset($opData[$direction]['encodingStyle']) && $encodingStyle != $opData[$direction]['encodingStyle']) {
                        $encodingStyle = $opData[$direction]['encodingStyle'];
                        $enc_style     = $encodingStyle;
                    } else {
                        $enc_style = false;
                    }
                    // NOTE: add error handling here
                    // if serializeType returns false, then catch global error and fault
                    if ('arraySimple' === $parametersArrayType) {
                        $p = array_shift($parameters);
                        $this->debug('calling serializeType w/indexed param');
                        $xml .= $this->serializeType($name, $type, $p, $use, $enc_style);
                    } elseif (isset($parameters[$name])) {
                        $this->debug('calling serializeType w/named param');
                        $xml .= $this->serializeType($name, $type, $parameters[$name], $use, $enc_style);
                    } else {
                        // TODO: only send nillable
                        $this->debug('calling serializeType w/null param');
                        $xml .= $this->serializeType($name, $type, null, $use, $enc_style);
                    }
                }
            } else {
                $this->debug('no parameters passed.');
            }
        }
        $this->debug("serializeParameters returning: $xml");

        return $xml;
    }

    /**
     * serializes a PHP value according a given type definition
     *
     * @param  string      $name          name of value (part or element)
     * @param  string      $type          XML schema type of value (type or element)
     * @param  mixed       $value         a native PHP value (parameter value)
     * @param  string      $use           use for part (encoded|literal)
     * @param  bool|string $encodingStyle SOAP encoding style for the value (if different than the enclosing style)
     * @param bool         $unqualified   a kludge for what should be XML namespace form handling
     * @return string      value serialized as an XML string
     */
    private function serializeType(
        $name,
        $type,
        $value,
        $use = 'encoded',
        $encodingStyle = false,
        $unqualified = false)
    {
        $this->debug("in serializeType: name=$name, type=$type, use=$use, encodingStyle=$encodingStyle, unqualified=" . ($unqualified ? 'unqualified' : 'qualified'));
        $this->appendDebug('value=' . $this->varDump($value));
        if ('encoded' === $use && $encodingStyle) {
            $encodingStyle = ' SOAP-ENV:encodingStyle="' . $encodingStyle . '"';
            $encodingStyle = ' SOAP-ENV:encodingStyle="' . /** @scrutinizer ignore-type */ $encodingStyle . '"';
        }

        // if a Soapval has been supplied, let its type override the WSDL
        if (is_object($value) && 'Soapval' === get_class($value)) {
            if ($value->type_ns) {
                $type      = $value->type_ns . ':' . $value->type;
                $forceType = true;
                $this->debug("in serializeType: soapval overrides type to $type");
            } elseif ($value->type) {
                $type      = $value->type;
                $forceType = true;
                $this->debug("in serializeType: soapval overrides type to $type");
            } else {
                $forceType = false;
                $this->debug('in serializeType: soapval does not override type');
            }
            $attrs = $value->attributes;
            $value = $value->value;
            $this->debug("in serializeType: soapval overrides value to $value");
            if ($attrs) {
                if (!is_array($value)) {
                    $value['!'] = $value;
                }
                foreach ($attrs as $n => $v) {
                    $value['!' . $n] = $v;
                }
                $this->debug('in serializeType: soapval provides attributes');
            }
        } else {
            $forceType = false;
        }

        $xml = '';
        if (mb_strpos($type, ':')) {
            $uqType = mb_substr($type, mb_strrpos($type, ':') + 1);
            $ns     = mb_substr($type, 0, mb_strrpos($type, ':'));
            $this->debug("in serializeType: got a prefixed type: $uqType, $ns");
            if ($this->getNamespaceFromPrefix($ns)) {
                $ns = $this->getNamespaceFromPrefix($ns);
                $this->debug("in serializeType: expanded prefixed type: $uqType, $ns");
            }

            if ($ns == $this->XMLSchemaVersion || 'http://schemas.xmlsoap.org/soap/encoding/' === $ns) {
                $this->debug('in serializeType: type namespace indicates XML Schema or SOAP Encoding type');
                $elementNS = '';
                if ($unqualified && 'literal' === $use) {
                    $elementNS = ' xmlns=""';
                }
                if (null === $value) {
                    if ('literal' === $use) {
                        // TODO: depends on minOccurs
                        $xml = "<$name$elementNS>";
                    } else {
                        // TODO: depends on nillable, which should be checked before calling this method
                        $xml = "<$name$elementNS xsi:nil=\"true\" xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">";
                        $xml = "<$name$elementNS xsi:nil=\"true\" xsi:type=\"" . /** @scrutinizer ignore-type */ $this->getPrefixFromNamespace($ns) . ":$uqType\">";
                    }
                    $this->debug("in serializeType: returning: $xml");

                    return $xml;
                }
                if ('Array' === $uqType) {
                    // JBoss/Axis does this sometimes
                    return $this->serialize_val($value, $name, false, false, false, false, $use);
                }
                if ('boolean' === $uqType) {
                    if ((is_string($value) && 'false' === $value) || (!$value)) {
                        $value = 'false';
                    } else {
                        $value = 'true';
                    }
                }
                if ('string' === $uqType && is_string($value)) {
                    $value = $this->expandEntities($value);
                }
                if (('long' === $uqType || 'unsignedLong' === $uqType) && is_float($value)) {
                    $value = sprintf('%.0lf', $value);
                }
                // it's a scalar
                // TODO: what about null/nil values?
                // check type isn't a custom type extending xmlschema namespace
                if (!$this->getTypeDef($uqType, $ns)) {
                    if ('literal' === $use) {
                        $xml = "<$name$elementNS>$value</$name>";
                        if ($forceType) {
                            $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">$value</$name>";
                        }
                    } else {
                        $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"$encodingStyle>$value</$name>";
                    }
                    $this->debug("in serializeType: returning: $xml");

                    return $xml;
                }
                $this->debug('custom type extends XML Schema or SOAP Encoding namespace (yuck)');
            } elseif ('http://xml.apache.org/xml-soap' === $ns) {
                $this->debug('in serializeType: appears to be Apache SOAP type');
                if ('Map' === $uqType) {
                    $tt_prefix = $this->getPrefixFromNamespace('http://xml.apache.org/xml-soap');
                    if (!$tt_prefix) {
                        $this->debug('in serializeType: Add namespace for Apache SOAP type');
                        $tt_prefix                    = 'ns' . mt_rand(1000, 9999);
                        $this->namespaces[$tt_prefix] = 'http://xml.apache.org/xml-soap';
                        // force this to be added to usedNamespaces
                        $tt_prefix = $this->getPrefixFromNamespace('http://xml.apache.org/xml-soap');
                    }
                    $contents = '';
                    foreach ($value as $k => $v) {
                        $this->debug("serializing map element: key $k, value $v");
                        $contents .= '<item>';
                        $contents .= $this->serialize_val($k, 'key', false, false, false, false, $use);
                        $contents .= $this->serialize_val($v, 'value', false, false, false, false, $use);
                        $contents .= '</item>';
                    }
                    if ('literal' === $use) {
                        $xml = "<$name>$contents</$name>";
                        if ($forceType) {
                            $xml = "<$name xsi:type=\"" . $tt_prefix . ":$uqType\">$contents</$name>";
                        }
                    } else {
                        $xml = "<$name xsi:type=\"" . $tt_prefix . ":$uqType\"$encodingStyle>$contents</$name>";
                    }
                    $this->debug("in serializeType: returning: $xml");

                    return $xml;
                }
                $this->debug('in serializeType: Apache SOAP type, but only support Map');
            }
        } else {
            // TODO: should the type be compared to types in XSD, and the namespace
            // set to XSD if the type matches?
            $this->debug("in serializeType: No namespace for type $type");
            $ns     = '';
            $uqType = $type;
        }
        if (!$typeDef = $this->getTypeDef($uqType, $ns)) {
            $this->setError("$type ($uqType) is not a supported type.");
            $this->debug("in serializeType: $type ($uqType) is not a supported type.");

            return false;

        }

        $this->debug('in serializeType: found typeDef');
        $this->appendDebug('typeDef=' . $this->varDump($typeDef));
        if ('^' === mb_substr($uqType, -1)) {
            $uqType = mb_substr($uqType, 0, -1);
        }
        if (!isset($typeDef['phpType'])) {
            $this->setError("$type ($uqType) has no phpType.");
            $this->debug("in serializeType: $type ($uqType) has no phpType.");

            return false;

        }
        $phpType = $typeDef['phpType'];
        $this->debug("in serializeType: uqType: $uqType, ns: $ns, phptype: $phpType, arrayType: " . (isset($typeDef['arrayType']) ? $typeDef['arrayType'] : ''));
        // if php type == struct, map value to the <all> element names
        if ('struct' === $phpType) {
            if (isset($typeDef['typeClass']) && 'element' === $typeDef['typeClass']) {
                $elementName = $uqType;
                $elementNS   = ' xmlns=""';
                if (isset($typeDef['form']) && ('qualified' === $typeDef['form'])) {
                    $elementNS = " xmlns=\"$ns\"";
                }
            } else {
                $elementName = $name;
                $elementNS   = '';
                if ($unqualified) {
                    $elementNS = ' xmlns=""';
                }
            }
            if (null === $value) {
                if ('literal' === $use) {
                    // TODO: depends on minOccurs and nillable
                    $xml = "<$elementName$elementNS>";
                } else {
                    $xml = "<$elementName$elementNS xsi:nil=\"true\" xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">";
                }
                $this->debug("in serializeType: returning: $xml");

                return $xml;
            }
            if (is_object($value)) {
                $value = get_object_vars($value);
            }
            if (is_array($value)) {
                $elementAttrs = $this->serializeComplexTypeAttributes($typeDef, $value, $ns, $uqType);
                if ('literal' === $use) {
                    $xml = "<$elementName$elementNS$elementAttrs>";
                    if ($forceType) {
                        $xml = "<$elementName$elementNS$elementAttrs xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">";
                    }
                } else {
                    $xml = "<$elementName$elementNS$elementAttrs xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"$encodingStyle>";
                }

                if (isset($typeDef['simpleContent']) && 'true' === $typeDef['simpleContent']) {
                    if (isset($value['!'])) {
                        $xml .= $value['!'];
                        $this->debug("in serializeType: serialized simpleContent for type $type");
                    } else {
                        $this->debug("in serializeType: no simpleContent to serialize for type $type");
                    }
                } else {
                    // complexContent
                    $xml .= $this->serializeComplexTypeElements($typeDef, $value, $ns, $uqType, $use, $encodingStyle);
                }
                $xml .= "</$elementName>";
            } else {
                $this->debug('in serializeType: phpType is struct, but value is not an array');
                $this->setError('phpType is struct, but value is not an array: see debug output for details');
                $xml = '';
            }
        } elseif ('array' === $phpType) {
            if (isset($typeDef['form']) && ('qualified' === $typeDef['form'])) {
                $elementNS = " xmlns=\"$ns\"";
            } else {
                $elementNS = '';
                if ($unqualified) {
                    $elementNS = ' xmlns=""';
                }
            }
            if (null === $value) {
                if ('literal' === $use) {
                    // TODO: depends on minOccurs
                    $xml = "<$name$elementNS>";
                } else {
                    $xml = "<$name$elementNS xsi:nil=\"true\" xsi:type=\""
                           . $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/')
                           . /** @scrutinizer ignore-type */ $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/')
                           . ':Array" '
                           . $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/')
                           . ':arrayType="'
                           . $this->getPrefixFromNamespace($this->getPrefix($typeDef['arrayType']))
                           . /** @scrutinizer ignore-type */ $this->getPrefixFromNamespace($this->getPrefix($typeDef['arrayType']))
                           . ':'
                           . $this->getLocalPart($typeDef['arrayType'])
                           . '[0]"/>';
                }
                $this->debug("in serializeType: returning: $xml");

                return $xml;
            }
            if (isset($typeDef['multidimensional'])) {
                $nv = [];
                foreach ($value as $v) {
                    $cols = ',' . count($v);
                    $nv   = array_merge($nv, $v);
                }
                $value = $nv;
            } else {
                $cols = '';
            }
            if (is_array($value) && count($value) >= 1) {
                $rows     = count($value);
                $contents = '';
                foreach ($value as $k => $v) {
                    $this->debug("serializing array element: $k, " . (is_array($v) ? 'array' : $v) . " of type: $typeDef[arrayType]");
                    //if (strpos($typeDef['arrayType'], ':') ) {
                    if (!in_array($typeDef['arrayType'], $this->typemap['http://www.w3.org/2001/XMLSchema'])) {
                        $contents .= $this->serializeType('item', $typeDef['arrayType'], $v, $use);
                    } else {
                        $contents .= $this->serialize_val($v, 'item', $typeDef['arrayType'], null, $this->XMLSchemaVersion, false, $use);
                    }
                }
            } else {
                $rows     = 0;
                $contents = null;
            }
            // TODO: for now, an empty value will be serialized as a zero element
            // array.  Revisit this when coding the handling of null/nil values.
            if ('literal' === $use) {
                $xml = "<$name$elementNS>" . $contents . "</$name>";
            } else {
                $xml = "<$name$elementNS xsi:type=\""
                       . $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/')
                       . ':Array" '
                       . $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/')
                       . ':arrayType="'
                       . $this->getPrefixFromNamespace($this->getPrefix($typeDef['arrayType']))
                       . ':'
                       . $this->getLocalPart($typeDef['arrayType'])
                       . "[$rows$cols]\">"

                       . $contents
                       . "</$name>";
            }
        } elseif ('scalar' === $phpType) {
            if (isset($typeDef['form']) && ('qualified' === $typeDef['form'])) {
                $elementNS = " xmlns=\"$ns\"";
            } else {
                if ($unqualified) {
                    $elementNS = ' xmlns=""';
                } else {
                    $elementNS = '';
                }
            }
            if ('literal' === $use) {
                if ($forceType) {
                    $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">$value</$name>";
                } else {
                    $xml = "<$name$elementNS>$value</$name>";
                }
            } else {
                $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"$encodingStyle>$value</$name>";
            }
        }
        $this->debug("in serializeType: returning: $xml");

        return $xml;
    }

    /**
     * serializes the attributes for a complexType
     *
     * @param  array  $typeDef our internal representation of an XML schema type (or element)
     * @param  mixed  $value   a native PHP value (parameter value)
     * @param  string $ns      the namespace of the type
     * @param  string $uqType  the local part of the type
     * @return string value serialized as an XML string
     */
    private function serializeComplexTypeAttributes($typeDef, $value, $ns, $uqType)
    {
        $this->debug("serializeComplexTypeAttributes for XML Schema type $ns:$uqType");
        $xml = '';
        if (isset($typeDef['extensionBase'])) {
            $nsx     = $this->getPrefix($typeDef['extensionBase']);
            $uqTypex = $this->getLocalPart($typeDef['extensionBase']);
            if ($this->getNamespaceFromPrefix($nsx)) {
            if ($this->getNamespaceFromPrefix(/** @scrutinizer ignore-type */ $nsx)) {
                $nsx = $this->getNamespaceFromPrefix($nsx);
            }
            if (false !== ($typeDefx = $this->getTypeDef($uqTypex, $nsx))) {
                $this->debug("serialize attributes for extension base $nsx:$uqTypex");
                $xml .= $this->serializeComplexTypeAttributes($typeDefx, $value, $nsx, $uqTypex);
            } else {
                $this->debug("extension base $nsx:$uqTypex is not a supported type");
            }
        }
        if (isset($typeDef['attrs']) && is_array($typeDef['attrs'])) {
            $this->debug("serialize attributes for XML Schema type $ns:$uqType");
            if (is_array($value)) {
                $xvalue = $value;
            } elseif (is_object($value)) {
                $xvalue = get_object_vars($value);
            } else {
                $this->debug("value is neither an array nor an object for XML Schema type $ns:$uqType");
                $xvalue = [];
            }
            foreach ($typeDef['attrs'] as $aName => $attrs) {
                if (isset($xvalue['!' . $aName])) {
                    $xname = '!' . $aName;
                    $this->debug("value provided for attribute $aName with key $xname");
                } elseif (isset($xvalue[$aName])) {
                    $xname = $aName;
                    $this->debug("value provided for attribute $aName with key $xname");
                } elseif (isset($attrs['default'])) {
                    $xname          = '!' . $aName;
                    $xvalue[$xname] = $attrs['default'];
                    $this->debug('use default value of ' . $xvalue[$aName] . ' for attribute ' . $aName);
                } else {
                    $xname = '';
                    $this->debug("no value provided for attribute $aName");
                }
                if ($xname) {
                    $xml .= " $aName=\"" . $this->expandEntities($xvalue[$xname]) . '"';
                }
            }
        } else {
            $this->debug("no attributes to serialize for XML Schema type $ns:$uqType");
        }

        return $xml;
    }

    /**
     * serializes the elements for a complexType
     *
     * @param  array       $typeDef       our internal representation of an XML schema type (or element)
     * @param  mixed       $value         a native PHP value (parameter value)
     * @param  string      $ns            the namespace of the type
     * @param  string      $uqType        the local part of the type
     * @param  string      $use           use for part (encoded|literal)
     * @param  bool|string $encodingStyle SOAP encoding style for the value (if different than the enclosing style)
     * @return string      value serialized as an XML string
     */
    private function serializeComplexTypeElements(
        $typeDef,
        $value,
        $ns,
        $uqType,
        $use = 'encoded',
        $encodingStyle = false)
    {
        $this->debug("in serializeComplexTypeElements for XML Schema type $ns:$uqType");
        $xml = '';
        if (isset($typeDef['extensionBase'])) {
            $nsx     = $this->getPrefix($typeDef['extensionBase']);
            $uqTypex = $this->getLocalPart($typeDef['extensionBase']);
            if ($this->getNamespaceFromPrefix($nsx)) {
            if ($this->getNamespaceFromPrefix(/** @scrutinizer ignore-type */ $nsx)) {
                $nsx = $this->getNamespaceFromPrefix($nsx);
            }
            if (false !== ($typeDefx = $this->getTypeDef($uqTypex, $nsx))) {
                $this->debug("serialize elements for extension base $nsx:$uqTypex");
                $xml .= $this->serializeComplexTypeElements($typeDefx, $value, $nsx, $uqTypex, $use, $encodingStyle);
            } else {
                $this->debug("extension base $nsx:$uqTypex is not a supported type");
            }
        }
        if (isset($typeDef['elements']) && is_array($typeDef['elements'])) {
            $this->debug("in serializeComplexTypeElements, serialize elements for XML Schema type $ns:$uqType");
            if (is_array($value)) {
                $xvalue = $value;
            } elseif (is_object($value)) {
                $xvalue = get_object_vars($value);
            } else {
                $this->debug("value is neither an array nor an object for XML Schema type $ns:$uqType");
                $xvalue = [];
            }
            // toggle whether all elements are present - ideally should validate against schema
            if (is_array($xvalue) && (count($typeDef['elements']) != count($xvalue))) {
                $optionals = true;
            }
            foreach ($typeDef['elements'] as $eName => $attrs) {
                if (!isset($xvalue[$eName])) {
                    if (isset($attrs['default'])) {
                        $xvalue[$eName] = $attrs['default'];
                        $this->debug('use default value of ' . $xvalue[$eName] . ' for element ' . $eName);
                    }
                }
                // if user took advantage of a minOccurs=0, then only serialize named parameters
                if (isset($optionals) && !isset($xvalue[$eName]) && (!isset($attrs['nillable']) || 'true' !== $attrs['nillable'])) {
                    if (isset($attrs['minOccurs']) && '0' != $attrs['minOccurs']) {
                        $this->debug("apparent error: no value provided for element $eName with minOccurs=" . $attrs['minOccurs']);
                    }
                    // do nothing
                    $this->debug("no value provided for complexType element $eName and element is not nillable, so serialize nothing");
                } else {
                    // get value
                    $v = null;
                    if (isset($xvalue[$eName])) {
                        $v = $xvalue[$eName];
                    }
                    $unqualified = false;
                    if (isset($attrs['form'])) {
                        $unqualified = ('unqualified' === $attrs['form']);
                    }
                    if (isset($attrs['maxOccurs']) && ('unbounded' === $attrs['maxOccurs'] || $attrs['maxOccurs'] > 1) && isset($v) && is_array($v) && 'arraySimple' === $this->isArraySimpleOrStruct($v)) {
                        $vv = $v;
                        foreach ($vv as $k => $v) {
                            if (isset($attrs['type']) || isset($attrs['ref'])) {
                                // serialize schema-defined type
                                $xml .= $this->serializeType($eName, isset($attrs['type']) ? $attrs['type'] : $attrs['ref'], $v, $use, $encodingStyle, $unqualified);
                            } else {
                                // serialize generic type (can this ever really happen?)
                                $this->debug("calling serialize_val() for $v, $eName, false, false, false, false, $use");
                                $xml .= $this->serialize_val($v, $eName, false, false, false, false, $use);
                            }
                        }
                    } else {
                        if (null === $v && isset($attrs['minOccurs']) && '0' == $attrs['minOccurs']) {
                            // do nothing
                        } elseif (null === $v && isset($attrs['nillable']) && 'true' === $attrs['nillable']) {
                            // TODO: serialize a nil correctly, but for now serialize schema-defined type
                            $xml .= $this->serializeType($eName, isset($attrs['type']) ? $attrs['type'] : $attrs['ref'], $v, $use, $encodingStyle, $unqualified);
                        } elseif (isset($attrs['type']) || isset($attrs['ref'])) {
                            // serialize schema-defined type
                            $xml .= $this->serializeType($eName, isset($attrs['type']) ? $attrs['type'] : $attrs['ref'], $v, $use, $encodingStyle, $unqualified);
                        } else {
                            // serialize generic type (can this ever really happen?)
                            $this->debug("calling serialize_val() for $v, $eName, false, false, false, false, $use");
                            $xml .= $this->serialize_val($v, $eName, false, false, false, false, $use);
                        }
                    }
                }
            }
        } else {
            $this->debug("no elements to serialize for XML Schema type $ns:$uqType");
        }

        return $xml;
    }

    /**
     * adds an XML Schema complex type to the WSDL types
     *
     * @param string $name
     * @param string $typeClass       (complexType|simpleType|attribute)
     * @param string $phpType         currently supported are array and struct (php assoc array)
     * @param string $compositor      (all|sequence|choice)
     * @param string $restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
     * @param array  $elements        e.g. array ( name => array(name=>'',type=>'') )
     * @param array  $attrs           e.g. array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]'))
     * @param string $arrayType       as namespace:name (xsd:string)
     * @see    nusoap_xmlschema
     */
    public function addComplexType(
        $name,
        $typeClass = 'complexType',
        $phpType = 'array',
        $compositor = '',
        $restrictionBase = '',
        $elements = [],
        $attrs = [],
        $arrayType = '')
    {
        if ($elements && is_array($elements)) {

            $eElements = [];
            foreach ($elements as $n => $e) {
                // expand each element
                $ee = [];
                foreach ($e as $k => $v) {
                    $k      = mb_strpos($k, ':') ? $this->expandQname($k) : $k;
                    $v      = mb_strpos($v, ':') ? $this->expandQname($v) : $v;
                    $ee[$k] = $v;
                }
                $eElements[$n] = $ee;
            }
            $elements = $eElements;
        }

        if ($attrs && is_array($attrs)) {

            foreach ($attrs as $n => $a) {
                // expand each attribute
                foreach ($a as $k => $v) {
                    $k      = mb_strpos($k, ':') ? $this->expandQname($k) : $k;
                    $v      = mb_strpos($v, ':') ? $this->expandQname($v) : $v;
                    $aa[$k] = $v;
                }
                $eAttrs[$n] = $aa;

            }
            $attrs = $eAttrs;

        }

        $restrictionBase = mb_strpos($restrictionBase, ':') ? $this->expandQname($restrictionBase) : $restrictionBase;
        $arrayType       = mb_strpos($arrayType, ':') ? $this->expandQname($arrayType) : $arrayType;

        $typens = isset($this->namespaces['types']) ? $this->namespaces['types'] : $this->namespaces['tns'];
        $this->schemas[$typens][0]->addComplexType($name, $typeClass, $phpType, $compositor, $restrictionBase, $elements, $attrs, $arrayType);
    }

    /**
     * adds an XML Schema simple type to the WSDL types
     *
     * @param string $name
     * @param string $restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
     * @param string $typeClass       (should always be simpleType)
     * @param string $phpType         (should always be scalar)
     * @param array  $enumeration     array of values
     * @see    nusoap_xmlschema
     */
    public function addSimpleType(
        $name,
        $restrictionBase = '',
        $typeClass = 'simpleType',
        $phpType = 'scalar',
        $enumeration = [])
    {
        $restrictionBase = mb_strpos($restrictionBase, ':') ? $this->expandQname($restrictionBase) : $restrictionBase;

        $typens = isset($this->namespaces['types']) ? $this->namespaces['types'] : $this->namespaces['tns'];
        $this->schemas[$typens][0]->addSimpleType($name, $restrictionBase, $typeClass, $phpType, $enumeration);
    }

    /**
     * adds an element to the WSDL types
     *
     * @param array $attrs attributes that must include name and type
     * @see    nusoap_xmlschema
     */
    public function addElement($attrs)
    {
        $typens = isset($this->namespaces['types']) ? $this->namespaces['types'] : $this->namespaces['tns'];
        $this->schemas[$typens][0]->addElement($attrs);
    }

    /**
     * register an operation with the server
     *
     * @param  string      $name          operation (method) name
     * @param bool|array   $in            assoc array of input values: key = param name, value = param type
     * @param bool|array   $out           assoc array of output values: key = param name, value = param type
     * @param  bool|string $namespace     optional The namespace for the operation
     * @param  bool|string $soapaction    optional The soapaction for the operation
     * @param  string      $style         (rpc|document) optional The style for the operation Note: when 'document' is specified, parameter and return wrappers are created for you automatically
     * @param  string      $use           (encoded|literal) optional The use for the parameters (cannot mix right now)
     * @param  string      $documentation optional The description to include in the WSDL
     * @param  string      $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)
     * @return bool
     */
    public function addOperation(
        $name,
        $in = false,
        $out = false,
        $namespace = false,
        $soapaction = false,
        $style = 'rpc',
        $use = 'encoded',
        $documentation = '',
        $encodingStyle = '')
    {
        if ('encoded' === $use && '' === $encodingStyle) {
            $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        }

        if ('document' === $style) {
            $elements = [];
            foreach ($in as $n => $t) {
                $elements[$n] = ['name' => $n, 'type' => $t, 'form' => 'unqualified'];
            }
            $this->addComplexType($name . 'RequestType', 'complexType', 'struct', 'all', '', $elements);
            $this->addElement(['name' => $name, 'type' => $name . 'RequestType']);
            $in = ['parameters' => 'tns:' . $name . '^'];

            $elements = [];
            foreach ($out as $n => $t) {
                $elements[$n] = ['name' => $n, 'type' => $t, 'form' => 'unqualified'];
            }
            $this->addComplexType($name . 'ResponseType', 'complexType', 'struct', 'all', '', $elements);
            $this->addElement(['name' => $name . 'Response', 'type' => $name . 'ResponseType', 'form' => 'qualified']);
            $out = ['parameters' => 'tns:' . $name . 'Response' . '^'];
        }

        // get binding
        $this->bindings[$this->serviceName . 'Binding']['operations'][$name] = [
            'name'          => $name,
            'binding'       => $this->serviceName . 'Binding',
            'endpoint'      => $this->endpoint,
            'soapAction'    => $soapaction,
            'style'         => $style,
            'input'         => [
                'use'           => $use,
                'namespace'     => $namespace,
                'encodingStyle' => $encodingStyle,
                'message'       => $name . 'Request',
                'parts'         => $in,
            ],
            'output'        => [
                'use'           => $use,
                'namespace'     => $namespace,
                'encodingStyle' => $encodingStyle,
                'message'       => $name . 'Response',
                'parts'         => $out,
            ],
            'namespace'     => $namespace,
            'transport'     => 'http://schemas.xmlsoap.org/soap/http',
            'documentation' => $documentation,
        ];
        // add portTypes
        // add messages
        if ($in) {
            foreach ($in as $pName => $pType) {
                if (mb_strpos($pType, ':')) {
                    $pType = $this->getNamespaceFromPrefix($this->getPrefix($pType)) . ':' . $this->getLocalPart($pType);
                }
                $this->messages[$name . 'Request'][$pName] = $pType;
            }
        } else {
            $this->messages[$name . 'Request'] = '0';
        }
        if ($out) {
            foreach ($out as $pName => $pType) {
                if (mb_strpos($pType, ':')) {
                    $pType = $this->getNamespaceFromPrefix($this->getPrefix($pType)) . ':' . $this->getLocalPart($pType);
                }
                $this->messages[$name . 'Response'][$pName] = $pType;
            }
        } else {
            $this->messages[$name . 'Response'] = '0';
        }

        return true;
    }
}

/**
 * nusoap_parser class parses SOAP XML messages into native PHP values
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Nusoap_parser extends Nusoap_base
{
    public $xml                   = '';
    public $xml_encoding          = '';
    public $method                = '';
    public $root_struct           = '';
    public $root_struct_name      = '';
    public $root_struct_namespace = '';
    public $root_header           = '';
    public $document              = '';            // incoming SOAP body (text)
    // determines where in the message we are (envelope,header,body,method)
    public $status            = '';
    public $position          = 0;
    public $depth             = 0;
    public $default_namespace = '';
    //    public $namespaces = []; //Field 'namespaces' is already defined in \nusoap_base
    public $message         = [];
    public $parent          = '';
    public $fault           = false;
    public $fault_code      = '';
    public $fault_str       = '';
    public $fault_detail    = '';
    public $depth_array     = [];
    public $debug_flag      = true;
    public $soapresponse;    // parsed SOAP Body
    public $soapheader;        // parsed SOAP Header
    public $responseHeaders = '';    // incoming SOAP headers (text)
    public $body_position   = 0;
    // for multiref parsing:
    // array of id => pos
    public $ids = [];
    // array of id => hrefs => pos
    public $multirefs = [];
    // toggle for auto-decoding element content
    public $decode_utf8 = true;

    /**
     * constructor that actually does the parsing
     *
     * @param string          $xml         SOAP message
     * @param string          $encoding    character encoding scheme of message
     * @param    string|array $method      method for which XML is parsed (unused?)
     * @param bool|string     $decode_utf8 whether to decode UTF-8 to ISO-8859-1
     */
    public function __construct($xml, $encoding = 'UTF-8', $method = '', $decode_utf8 = true)
    {
        parent::__construct();
        $this->xml          = $xml;
        $this->xml_encoding = $encoding;
        $this->method       = $method;
        $this->decode_utf8  = $decode_utf8;

        // Check whether content has been read.
        if (!empty($xml)) {
            // Check XML encoding
            $pos_xml = mb_strpos($xml, '<?xml');
            if (false !== $pos_xml) {
                $xml_decl = mb_substr($xml, $pos_xml, mb_strpos($xml, '?>', $pos_xml + 2) - $pos_xml + 1);
                if (preg_match("/encoding=[\"']([^\"']*)[\"']/", $xml_decl, $res)) {
                    $xml_encoding = $res[1];
                    if (mb_strtoupper($xml_encoding) != $encoding) {
                        $err = "Charset from HTTP Content-Type '" . $encoding . "' does not match encoding from XML declaration '" . $xml_encoding . "'";
                        $this->debug($err);
                        if ('ISO-8859-1' !== $encoding || 'UTF-8' !== mb_strtoupper($xml_encoding)) {
                            $this->setError($err);

                            return;
                        }
                        // when HTTP says ISO-8859-1 (the default) and XML says UTF-8 (the typical), assume the other endpoint is just sloppy and proceed
                    } else {
                        $this->debug('Charset from HTTP Content-Type matches encoding from XML declaration');
                    }
                } else {
                    $this->debug('No encoding specified in XML declaration');
                }
            } else {
                $this->debug('No XML declaration');
            }
            $this->debug('Entering nusoap_parser(), length=' . mb_strlen($xml) . ', encoding=' . $encoding);
            // Create an XML parser - why not xml_parser_create_ns?
            $this->parser = xml_parser_create($this->xml_encoding);

            // Set the options for parsing the XML data.
            //xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
            xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
            xml_parser_set_option($this->parser, XML_OPTION_TARGET_ENCODING, $this->xml_encoding);
            // Set the object for the parser.
            xml_set_object($this->parser, $this);
            // Set the element handlers for the parser.
            xml_set_element_handler($this->parser, 'start_element', 'end_element');
            xml_set_character_data_handler($this->parser, 'character_data');

            // Parse the XML file.
            if (!xml_parse($this->parser, $xml, true)) {
                // Display an error message.
                $err = sprintf('XML error parsing SOAP payload on line %d: %s', xml_get_current_line_number($this->parser), xml_error_string(xml_get_error_code($this->parser)));
                $this->debug($err);
                $this->debug("XML payload:\n" . $xml);
                $this->setError($err);
            } else {
                $this->debug('in nusoap_parser ctor, message:');
                $this->appendDebug($this->varDump($this->message));
                $this->debug('parsed successfully, found root struct: ' . $this->root_struct . ' of name ' . $this->root_struct_name);
                // get final value
                $this->soapresponse = $this->message[$this->root_struct]['result'];
                // get header value
                if ('' !== $this->root_header && isset($this->message[$this->root_header]['result'])) {
                    $this->soapheader = $this->message[$this->root_header]['result'];
                }
                // resolve hrefs/ids
                if ($this->multirefs && is_array($this->multirefs)) {

                    foreach ($this->multirefs as $id => $hrefs) {
                        $this->debug('resolving multirefs for id: ' . $id);
                        $idVal = $this->buildVal($this->ids[$id]);
                        if (is_array($idVal) && isset($idVal['!id'])) {
                            unset($idVal['!id']);
                        }
                        foreach ($hrefs as $refPos => $ref) {
                            $this->debug('resolving href at pos ' . $refPos);
                            $this->multirefs[$id][$refPos] = $idVal;
                        }
                    }
                }
            }
            xml_parser_free($this->parser);
            unset($this->parser);
        } else {
            $this->debug('xml was empty, didn\'t parse!');
            $this->setError('xml was empty, didn\'t parse!');
        }
    }

    /**
     * start-element handler
     *
     * @param resource $parser XML parser object
     * @param string   $name   element name
     * @param array    $attrs  associative array of attributes
     */
    private function start_element($parser, $name, $attrs)
    private function start_element(/** @scrutinizer ignore-unused */ $parser, $name, $attrs)
    {
        // position in a total number of elements, starting from 0
        // update class level pos
        $pos = $this->position++;
        // and set mine
        $this->message[$pos] = ['pos' => $pos, 'children' => '', 'cdata' => ''];
        // depth = how many levels removed from root?
        // set mine as current global depth and increment global depth value
        $this->message[$pos]['depth'] = $this->depth++;

        // else add self as child to whoever the current parent is
        if (0 != $pos) {
            $this->message[$this->parent]['children'] .= '|' . $pos;
        }
        // set my parent
        $this->message[$pos]['parent'] = $this->parent;
        // set self as current parent
        $this->parent = $pos;
        // set self as current value for this depth
        $this->depth_array[$this->depth] = $pos;
        // get element prefix
        if (mb_strpos($name, ':')) {
            // get ns prefix
            $prefix = mb_substr($name, 0, mb_strpos($name, ':'));
            // get unqualified name
            $name = mb_substr(mb_strstr($name, ':'), 1);
        }
        // set status
        if ('Envelope' === $name && '' === $this->status) {
            $this->status = 'envelope';
        } elseif ('Header' === $name && 'envelope' === $this->status) {
            $this->root_header = $pos;
            $this->status      = 'header';
        } elseif ('Body' === $name && 'envelope' === $this->status) {
            $this->status        = 'body';
            $this->body_position = $pos;
            // set method
        } elseif ('body' === $this->status && $pos == ($this->body_position + 1)) {
            $this->status                = 'method';
            $this->root_struct_name      = $name;
            $this->root_struct           = $pos;
            $this->message[$pos]['type'] = 'struct';
            $this->debug("found root struct $this->root_struct_name, pos $this->root_struct");
        }
        // set my status
        $this->message[$pos]['status'] = $this->status;
        // set name
        $this->message[$pos]['name'] = htmlspecialchars($name, ENT_QUOTES | ENT_HTML5);
        // set attrs
        $this->message[$pos]['attrs'] = $attrs;

        // loop through atts, logging ns and type declarations
        $attstr = '';
        foreach ($attrs as $key => $value) {
            $key_prefix    = $this->getPrefix($key);
            $key_localpart = $this->getLocalPart($key);
            // if ns declarations, add to class level array of valid namespaces
            if ('xmlns' === $key_prefix) {
                if (preg_match('/^http:\/\/www.w3.org\/[0-9]{4}\/XMLSchema$/', $value)) {
                    $this->XMLSchemaVersion  = $value;
                    $this->namespaces['xsd'] = $this->XMLSchemaVersion;
                    $this->namespaces['xsi'] = $this->XMLSchemaVersion . '-instance';
                }
                $this->namespaces[$key_localpart] = $value;
                // set method namespace
                if ($name == $this->root_struct_name) {
                    $this->methodNamespace = $value;

                }
                // if it's a type declaration, set type
            } elseif ('type' === $key_localpart) {
                if (isset($this->message[$pos]['type']) && 'array' === $this->message[$pos]['type']) {
                    // do nothing: already processed arrayType
                } else {
                    $value_prefix                      = $this->getPrefix($value);
                    $value_localpart                   = $this->getLocalPart($value);
                    $this->message[$pos]['type']       = $value_localpart;
                    $this->message[$pos]['typePrefix'] = $value_prefix;
                    if (isset($this->namespaces[$value_prefix])) {
                        $this->message[$pos]['type_namespace'] = $this->namespaces[$value_prefix];
                    } elseif (isset($attrs['xmlns:' . $value_prefix])) {
                    } elseif (isset($attrs['xmlns:' . /** @scrutinizer ignore-type */ $value_prefix])) {
                        $this->message[$pos]['type_namespace'] = $attrs['xmlns:' . $value_prefix];
                    }
                    // should do something here with the namespace of specified type?
                }
            } elseif ('arrayType' === $key_localpart) {
                $this->message[$pos]['type'] = 'array';
                /* do arrayType ereg here
                [1]    arrayTypeValue    ::=    atype asize
                [2]    atype    ::=    QName rank*
                [3]    rank    ::=    '[' (',')* ']'
                [4]    asize    ::=    '[' length~ ']'
                [5]    length    ::=    nextDimension* Digit+
                [6]    nextDimension    ::=    Digit+ ','
                */
                $expr = '/([A-Za-z0-9_]+):([A-Za-z]+[A-Za-z0-9_]+)\[([0-9]+),?([0-9]*)\]/';
                if (preg_match($expr, $value, $regs)) {
                    $this->message[$pos]['typePrefix']      = $regs[1];
                    $this->message[$pos]['arrayTypePrefix'] = $regs[1];
                    if (isset($this->namespaces[$regs[1]])) {
                        $this->message[$pos]['arrayTypeNamespace'] = $this->namespaces[$regs[1]];
                    } elseif (isset($attrs['xmlns:' . $regs[1]])) {
                        $this->message[$pos]['arrayTypeNamespace'] = $attrs['xmlns:' . $regs[1]];
                    }
                    $this->message[$pos]['arrayType'] = $regs[2];
                    $this->message[$pos]['arraySize'] = $regs[3];
                    $this->message[$pos]['arrayCols'] = $regs[4];
                }
                // specifies nil value (or not)
            } elseif ('nil' === $key_localpart) {
                $this->message[$pos]['nil'] = ('true' === $value || '1' == $value);
                // some other attribute
            } elseif ('href' !== $key && 'xmlns' !== $key && 'encodingStyle' !== $key_localpart && 'root' !== $key_localpart) {
                $this->message[$pos]['xattrs']['!' . $key] = $value;
            }

            if ('xmlns' === $key) {
                $this->default_namespace = $value;
            }
            // log id
            if ('id' === $key) {
                $this->ids[$value] = $pos;
            }
            // root
            if ('root' === $key_localpart && 1 == $value) {
                $this->status           = 'method';
                $this->root_struct_name = $name;
                $this->root_struct      = $pos;
                $this->debug("found root struct $this->root_struct_name, pos $pos");
            }
            // for doclit
            $attstr .= " $key=\"$value\"";
        }
        // get namespace - must be done after namespace atts are processed
        if (isset($prefix)) {
            $this->message[$pos]['namespace'] = $this->namespaces[$prefix];
            $this->default_namespace          = $this->namespaces[$prefix];
        } else {
            $this->message[$pos]['namespace'] = $this->default_namespace;
        }
        if ('header' === $this->status) {
            if ($this->root_header != $pos) {
                $this->responseHeaders .= '<' . (isset($prefix) ? $prefix . ':' : '') . "$name$attstr>";
            }
        } elseif ('' !== $this->root_struct_name) {
            $this->document .= '<' . (isset($prefix) ? $prefix . ':' : '') . "$name$attstr>";
        }
    }

    /**
     * end-element handler
     *
     * @param resource $parser XML parser object
     * @param string   $name   element name
     */
    private function end_element($parser, $name)
    private function end_element(/** @scrutinizer ignore-unused */ $parser, $name)
    {
        // position of current element is equal to the last value left in depth_array for my depth
        $pos = $this->depth_array[$this->depth--];

        // get element prefix
        if (mb_strpos($name, ':')) {
            // get ns prefix
            $prefix = mb_substr($name, 0, mb_strpos($name, ':'));
            // get unqualified name
            $name = mb_substr(mb_strstr($name, ':'), 1);
        }

        // build to native type
        if (isset($this->body_position) && $pos > $this->body_position) {
            // deal w/ multirefs
            if (isset($this->message[$pos]['attrs']['href'])) {
                // get id
                $id = mb_substr($this->message[$pos]['attrs']['href'], 1);
                // add placeholder to href array
                $this->multirefs[$id][$pos] = 'placeholder';
                // add set a reference to it as the result value
                $this->message[$pos]['result'] = $this->multirefs[$id][$pos];
                // build complexType values
            } elseif ('' !== $this->message[$pos]['children']) {
                // if result has already been generated (struct/array)
                if (!isset($this->message[$pos]['result'])) {
                    $this->message[$pos]['result'] = $this->buildVal($pos);
                }
                // build complexType values of attributes and possibly simpleContent
            } elseif (isset($this->message[$pos]['xattrs'])) {
                if (isset($this->message[$pos]['nil']) && $this->message[$pos]['nil']) {
                    $this->message[$pos]['xattrs']['!'] = null;
                } elseif (isset($this->message[$pos]['cdata']) && '' !== trim($this->message[$pos]['cdata'])) {
                    if (isset($this->message[$pos]['type'])) {
                        $this->message[$pos]['xattrs']['!'] = $this->decodeSimple($this->message[$pos]['cdata'], $this->message[$pos]['type'], isset($this->message[$pos]['type_namespace']) ? $this->message[$pos]['type_namespace'] : '');
                    } else {
                        $parent = $this->message[$pos]['parent'];
                        if (isset($this->message[$parent]['type']) && ('array' === $this->message[$parent]['type']) && isset($this->message[$parent]['arrayType'])) {
                            $this->message[$pos]['xattrs']['!'] = $this->decodeSimple($this->message[$pos]['cdata'], $this->message[$parent]['arrayType'], isset($this->message[$parent]['arrayTypeNamespace']) ? $this->message[$parent]['arrayTypeNamespace'] : '');
                        } else {
                            $this->message[$pos]['xattrs']['!'] = $this->message[$pos]['cdata'];
                        }
                    }
                }
                $this->message[$pos]['result'] = $this->message[$pos]['xattrs'];
                // set value of simpleType (or nil complexType)
            } else {
                //$this->debug('adding data for scalar value '.$this->message[$pos]['name'].' of value '.$this->message[$pos]['cdata']);
                if (isset($this->message[$pos]['nil']) && $this->message[$pos]['nil']) {
                    $this->message[$pos]['xattrs']['!'] = null;
                } elseif (isset($this->message[$pos]['type'])) {
                    $this->message[$pos]['result'] = $this->decodeSimple($this->message[$pos]['cdata'], $this->message[$pos]['type'], isset($this->message[$pos]['type_namespace']) ? $this->message[$pos]['type_namespace'] : '');
                } else {
                    $parent = $this->message[$pos]['parent'];
                    if (isset($this->message[$parent]['type']) && ('array' === $this->message[$parent]['type']) && isset($this->message[$parent]['arrayType'])) {
                        $this->message[$pos]['result'] = $this->decodeSimple($this->message[$pos]['cdata'], $this->message[$parent]['arrayType'], isset($this->message[$parent]['arrayTypeNamespace']) ? $this->message[$parent]['arrayTypeNamespace'] : '');
                    } else {
                        $this->message[$pos]['result'] = $this->message[$pos]['cdata'];
                    }
                }

                /* add value to parent's result, if parent is struct/array
                $parent = $this->message[$pos]['parent'];
                if ($this->message[$parent]['type'] != 'map') {
                    if (strtolower($this->message[$parent]['type']) == 'array') {
                        $this->message[$parent]['result'][] = $this->message[$pos]['result'];
                    } else {
                        $this->message[$parent]['result'][$this->message[$pos]['name']] = $this->message[$pos]['result'];
                    }
                }
                */
            }
        }

        // for doclit
        if ('header' === $this->status) {
            if ($this->root_header != $pos) {
                $this->responseHeaders .= '</' . (isset($prefix) ? $prefix . ':' : '') . "$name>";
            }
        } elseif ($pos >= $this->root_struct) {
            $this->document .= '</' . (isset($prefix) ? $prefix . ':' : '') . "$name>";
        }
        // switch status
        if ($pos == $this->root_struct) {
            $this->status                = 'body';
            $this->root_struct_namespace = $this->message[$pos]['namespace'];
        } elseif ($pos == $this->root_header) {
            $this->status = 'envelope';
        } elseif ('Body' === $name && 'body' === $this->status) {
            $this->status = 'envelope';
        } elseif ('Header' === $name && 'header' === $this->status) {
            // will never happen
            $this->status = 'envelope';
        } elseif ('Envelope' === $name && 'envelope' === $this->status) {
            $this->status = '';
        }
        // set parent back to my parent
        $this->parent = $this->message[$pos]['parent'];
    }

    /**
     * element content handler
     *
     * @param resource $parser XML parser object
     * @param string   $data   element content
     */
    private function character_data($parser, $data)
    private function character_data(/** @scrutinizer ignore-unused */ $parser, $data)
    {
        $pos = $this->depth_array[$this->depth];
        if ('UTF-8' === $this->xml_encoding) {
            // TODO: add an option to disable this for folks who want
            // raw UTF-8 that, e.g., might not map to iso-8859-1
            // TODO: this can also be handled with xml_parser_set_option($this->parser, XML_OPTION_TARGET_ENCODING, "ISO-8859-1");
            if ($this->decode_utf8) {
                $data = utf8_decode($data);
            }
        }
        $this->message[$pos]['cdata'] .= $data;
        // for doclit
        if ('header' === $this->status) {
            $this->responseHeaders .= $data;
        } else {
            $this->document .= $data;
        }
    }

    /**
     * get the parsed message (SOAP Body)
     *
     * @return mixed
     * @deprecated   use get_soapbody instead
     */
    public function get_response()
    {
        return $this->soapresponse;
    }

    /**
     * get the parsed SOAP Body (null if there was none)
     *
     * @return mixed
     */
    public function get_soapbody()
    {
        return $this->soapresponse;
    }

    /**
     * get the parsed SOAP Header (null if there was none)
     *
     * @return mixed
     */
    public function get_soapheader()
    {
        return $this->soapheader;
    }

    /**
     * get the unparsed SOAP Header
     *
     * @return string XML or empty if no Header
     */
    public function getHeaders()
    {
        return $this->responseHeaders;
    }

    /**
     * decodes simple types into PHP variables
     *
     * @param  string $value  value to decode
     * @param  string $type   XML type to decode
     * @param  string $typens XML type namespace to decode
     * @return mixed  PHP value
     */
    private function decodeSimple($value, $type, $typens)
    private function decodeSimple($value, $type, /** @scrutinizer ignore-unused */ $typens)
    {
        // TODO: use the namespace!
        if (!isset($type) || 'string' === $type || 'long' === $type || 'unsignedLong' === $type) {
            return (string)$value;
        }
        if ('int' === $type || 'integer' === $type || 'short' === $type || 'byte' === $type) {
            return (int)$value;
        }
        if ('float' === $type || 'double' === $type || 'decimal' === $type) {
            return (float)$value;
        }
        if ('boolean' === $type) {
            if ('false' === mb_strtolower($value) || 'f' === mb_strtolower($value)) {
                return false;
            }

            return (bool)$value;
        }
        if ('base64' === $type || 'base64Binary' === $type) {
            $this->debug('Decode base64 value');

            return base64_decode($value, true);
        }
        // obscure numeric types
        if ('nonPositiveInteger' === $type || 'negativeInteger' === $type || 'nonNegativeInteger' === $type || 'positiveInteger' === $type || 'unsignedInt' === $type || 'unsignedShort' === $type || 'unsignedByte' === $type) {
            return (int)$value;
        }
        // bogus: parser treats array with no elements as a simple type
        if ('array' === $type) {
            return [];
        }

        // everything else
        return (string)$value;
    }

    /**
     * builds response structures for compound values (arrays/structs)
     * and scalars
     *
     * @param int $pos position in node tree
     * @return mixed   PHP value
     */
    private function buildVal($pos)
    {
        if (!isset($this->message[$pos]['type'])) {
            $this->message[$pos]['type'] = '';
        }
        $this->debug('in buildVal() for ' . $this->message[$pos]['name'] . "(pos $pos) of type " . $this->message[$pos]['type']);
        // if there are children...
        if ('' !== $this->message[$pos]['children']) {
            $this->debug('in buildVal, there are children');
            $children = explode('|', $this->message[$pos]['children']);
            array_shift($children); // knock off empty
            // md array
            if (isset($this->message[$pos]['arrayCols']) && '' !== $this->message[$pos]['arrayCols']) {
                $r = 0; // rowcount
                $c = 0; // colcount
                foreach ($children as $child_pos) {
                    $this->debug("in buildVal, got an MD array element: $r, $c");
                    $params[$r][] = $this->message[$child_pos]['result'];
                    ++$c;
                    if ($c == $this->message[$pos]['arrayCols']) {
                        $c = 0;
                        ++$r;
                    }
                }
                // array
            } elseif ('array' === $this->message[$pos]['type'] || 'Array' === $this->message[$pos]['type']) {
                $this->debug('in buildVal, adding array ' . $this->message[$pos]['name']);
                foreach ($children as $child_pos) {
                    $params[] = $this->message[$child_pos]['result'];
                }
                // apache Map type: java hashtable
            } elseif ('Map' === $this->message[$pos]['type'] && 'http://xml.apache.org/xml-soap' === $this->message[$pos]['type_namespace']) {
                $this->debug('in buildVal, Java Map ' . $this->message[$pos]['name']);
                foreach ($children as $child_pos) {
                    $kv                                       = explode('|', $this->message[$child_pos]['children']);
                    $params[$this->message[$kv[1]]['result']] = $this->message[$kv[2]]['result'];
                }
                // generic compound type
                //} elseif ($this->message[$pos]['type'] == 'SOAPStruct' || $this->message[$pos]['type'] == 'struct') {
            } else {
                // Apache Vector type: treat as an array
                $this->debug('in buildVal, adding Java Vector or generic compound type ' . $this->message[$pos]['name']);
                if ('Vector' === $this->message[$pos]['type'] && 'http://xml.apache.org/xml-soap' === $this->message[$pos]['type_namespace']) {
                    $notstruct = 1;
                } else {
                    $notstruct = 0;
                }

                foreach ($children as $child_pos) {
                    if ($notstruct) {
                        $params[] = &$this->message[$child_pos]['result'];
                    } else {
                        if (isset($params[$this->message[$child_pos]['name']])) {
                            // de-serialize repeated element name into an array
                            if ((!is_array($params[$this->message[$child_pos]['name']])) || !isset($params[$this->message[$child_pos]['name']][0])) {

                                $params[$this->message[$child_pos]['name']] = [$params[$this->message[$child_pos]['name']]];
                            }
                            $params[$this->message[$child_pos]['name']][] = &$this->message[$child_pos]['result'];
                        } else {
                            $params[$this->message[$child_pos]['name']] = &$this->message[$child_pos]['result'];
                        }
                    }
                }
            }
            if (isset($this->message[$pos]['xattrs'])) {
                $this->debug('in buildVal, handling attributes');
                foreach ($this->message[$pos]['xattrs'] as $n => $v) {
                    $params[$n] = $v;
                }
            }
            // handle simpleContent
            if (isset($this->message[$pos]['cdata']) && '' !== trim($this->message[$pos]['cdata'])) {
                $this->debug('in buildVal, handling simpleContent');
                if (isset($this->message[$pos]['type'])) {
                    $params['!'] = $this->decodeSimple($this->message[$pos]['cdata'], $this->message[$pos]['type'], isset($this->message[$pos]['type_namespace']) ? $this->message[$pos]['type_namespace'] : '');
                } else {
                    $parent = $this->message[$pos]['parent'];
                    if (isset($this->message[$parent]['type']) && ('array' === $this->message[$parent]['type']) && isset($this->message[$parent]['arrayType'])) {
                        $params['!'] = $this->decodeSimple($this->message[$pos]['cdata'], $this->message[$parent]['arrayType'], isset($this->message[$parent]['arrayTypeNamespace']) ? $this->message[$parent]['arrayTypeNamespace'] : '');
                    } else {
                        $params['!'] = $this->message[$pos]['cdata'];
                    }
                }
            }
            $ret = is_array($params) ? $params : [];
            $this->debug('in buildVal, return:');
            $this->appendDebug($this->varDump($ret));

            return $ret;
        }

        $this->debug('in buildVal, no children, building scalar');
        $cdata = isset($this->message[$pos]['cdata']) ? $this->message[$pos]['cdata'] : '';
        if (isset($this->message[$pos]['type'])) {
            $ret = $this->decodeSimple($cdata, $this->message[$pos]['type'], isset($this->message[$pos]['type_namespace']) ? $this->message[$pos]['type_namespace'] : '');
            $this->debug("in buildVal, return: $ret");

            return $ret;
        }
        $parent = $this->message[$pos]['parent'];
        if (isset($this->message[$parent]['type']) && ('array' === $this->message[$parent]['type']) && isset($this->message[$parent]['arrayType'])) {
            $ret = $this->decodeSimple($cdata, $this->message[$parent]['arrayType'], isset($this->message[$parent]['arrayTypeNamespace']) ? $this->message[$parent]['arrayTypeNamespace'] : '');
            $this->debug("in buildVal, return: $ret");

            return $ret;
        }
        $ret = $this->message[$pos]['cdata'];
        $this->debug("in buildVal, return: $ret");

        return $ret;
    }
}

/**
 * Backward compatibility
 */
class Soap_parser extends Nusoap_parser
{
}

/**
 * [nu]soapclient higher level class for easy usage.
 *
 * usage:
 *
 * // instantiate client with server info
 * $soapclient = new Nusoap_client( string path [ ,mixed wsdl] );
 *
 * // call method, get results
 * echo $soapclient->call( string methodname [ ,array parameters] );
 *
 * // bye bye client
 * unset($soapclient);
 *
 * @author   Dietrich Ayala <[email protected]>
 * @author   Scott Nichol <[email protected]>
 */
class Nusoap_client extends Nusoap_base
{
    public $username             = '';                // Username for HTTP authentication
    public $password             = '';                // Password for HTTP authentication
    public $authtype             = '';                // Type of HTTP authentication
    public $certRequest          = [];        // Certificate for HTTP SSL authentication
    public $requestHeaders       = false;    // SOAP headers in request (text)
    public $responseHeaders      = '';        // SOAP headers from response (incomplete namespace resolution) (text)
    public $responseHeader;        // SOAP Header from response (parsed)
    public $document             = '';                // SOAP body response portion (incomplete namespace resolution) (text)
    public $endpoint;
    public $forceEndpoint        = '';        // overrides WSDL endpoint
    public $proxyhost            = '';
    public $proxyport            = '';
    public $proxyusername        = '';
    public $proxypassword        = '';
    public $portName             = '';                // port name to use in WSDL
    public $xml_encoding         = '';            // character set encoding of incoming (response) messages
    public $http_encoding        = false;
    public $timeout              = 0;                // HTTP connection timeout
    public $response_timeout     = 30;        // HTTP response timeout
    public $endpointType         = '';            // soap|wsdl, empty for WSDL initialization error
    public $persistentConnection = false;
    public $defaultRpcParams     = false;    // This is no longer used
    public $request              = '';                // HTTP request
    public $response             = '';                // HTTP response
    public $responseData         = '';            // SOAP payload of response
    public $cookies              = [];            // Cookies from response or for request
    public $decode_utf8          = true;        // toggles whether the parser decodes element content w/ utf8_decode()
    public $operations           = [];        // WSDL operations, empty for WSDL initialization error
    public $curl_options         = [];    // User-specified cURL options
    public $bindingType          = '';            // WSDL operation binding type
    public $use_curl             = false;            // whether to always try to use cURL

    /*
     * fault related variables
     */
    /**
     * @var  string|bool $fault
     */
    public $fault;
    /**
     * @var  string $faultcode
     */
    public $faultcode;
    /**
     * @var string $faultstring
     */
    public $faultstring;
    /**
     * @var string $faultdetail
     */
    public $faultdetail;

    /**
     * constructor
     *
     * @param mixed       $endpoint         SOAP server or WSDL URL (string) , or wsdl instance (object)
     * @param mixed       $wsdl             optional, set to 'wsdl' or true if using WSDL
     * @param bool|string $proxyhost        optional
     * @param bool|string $proxyport        optional
     * @param bool|string $proxyusername    optional
     * @param bool|string $proxypassword    optional
     * @param int         $timeout          set the connection timeout
     * @param int         $response_timeout set the response timeout
     * @param string      $portName         optional portName in WSDL document
     */
    public function __construct(
        $endpoint,
        $wsdl = false,
        $proxyhost = false,
        $proxyport = false,
        $proxyusername = false,
        $proxypassword = false,
        $timeout = 0,
        $response_timeout = 30,
        $portName = '')
    {
        parent::__construct();
        $this->endpoint         = $endpoint;
        $this->proxyhost        = $proxyhost;
        $this->proxyport        = $proxyport;
        $this->proxyusername    = $proxyusername;
        $this->proxypassword    = $proxypassword;
        $this->timeout          = $timeout;
        $this->response_timeout = $response_timeout;
        $this->portName         = $portName;

        $this->debug("ctor wsdl=$wsdl timeout=$timeout response_timeout=$response_timeout");
        $this->appendDebug('endpoint=' . $this->varDump($endpoint));

        // make values
        if ($wsdl) {
            if (is_object($endpoint) && ('Wsdl' === get_class($endpoint))) {
                $this->wsdl     = $endpoint;

                $this->endpoint = $this->wsdl->wsdl;
                $this->wsdlFile = $this->endpoint;

                $this->debug('existing wsdl instance created from ' . $this->endpoint);
                $this->checkWSDL();
            } else {
                $this->wsdlFile = $this->endpoint;
                $this->wsdl     = null;
                $this->debug('will use lazy evaluation of wsdl from ' . $this->endpoint);
            }
            $this->endpointType = 'wsdl';
        } else {
            $this->debug("instantiate SOAP with endpoint at $endpoint");
            $this->endpointType = 'soap';
        }
    }

    /**
     * calls method, returns PHP native type
     *
     * @param  string $operation   SOAP server URL or path
     * @param  mixed  $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.
     * @param  string $namespace   optional method namespace (WSDL can override)
     * @param  string $soapAction  optional SOAPAction value (WSDL can override)
     * @param  mixed  $headers     optional string of XML with SOAP header content, or array of soapval objects for SOAP headers, or associative array
     * @param  bool   $rpcParams   optional (no longer used)
     * @param  string $style       optional (rpc|document) the style to use when serializing parameters (WSDL can override)
     * @param  string $use         optional (encoded|literal) the use when serializing parameters (WSDL can override)
     * @return mixed   response from SOAP call, normally an associative array mirroring the structure of the XML response, false for certain fatal errors
     */
    public function call(
        $operation,
        $params = [],
        $namespace = 'http://tempuri.org',
        $soapAction = '',
        $headers = false,
        $rpcParams = null,
        $style = 'rpc',
        $use = 'encoded')
    {
        $this->operation = $operation;

        $this->fault     = false;
        $this->setError('');
        $this->request      = '';
        $this->response     = '';
        $this->responseData = '';
        $this->faultstring  = '';
        $this->faultcode    = '';
        $this->opData       = [];

        $this->debug("call: operation=$operation, namespace=$namespace, soapAction=$soapAction, rpcParams=$rpcParams, style=$style, use=$use, endpointType=$this->endpointType");
        $this->appendDebug('params=' . $this->varDump($params));
        $this->appendDebug('headers=' . $this->varDump($headers));
        if ($headers) {
            $this->requestHeaders = $headers;
        }
        if ('Wsdl' === $this->endpointType && null === $this->wsdl) {
            $this->loadWSDL();
            if ($this->getError()) {
                return false;
            }
        }
        // serialize parameters
        if ('Wsdl' === $this->endpointType && $opData = $this->getOperationData($operation)) {
            // use WSDL for operation
            $this->opData = $opData;
            $this->debug('found operation');
            $this->appendDebug('opData=' . $this->varDump($opData));
            if (isset($opData['soapAction'])) {
                $soapAction = $opData['soapAction'];
            }
            if (!$this->forceEndpoint) {
                $this->endpoint = $opData['endpoint'];
            } else {
                $this->endpoint = $this->forceEndpoint;
            }
            $namespace = isset($opData['input']['namespace']) ? $opData['input']['namespace'] : $namespace;
            $style     = $opData['style'];
            $use       = $opData['input']['use'];
            // add ns to ns array
            if ('' !== $namespace && !isset($this->wsdl->namespaces[$namespace])) {
                $nsPrefix                          = 'ns' . mt_rand(1000, 9999);
                $this->wsdl->namespaces[$nsPrefix] = $namespace;
            }
            $nsPrefix = $this->wsdl->getPrefixFromNamespace($namespace);
            // serialize payload
            if (is_string($params)) {
                $this->debug("serializing param string for WSDL operation $operation");
                $payload = $params;
            } elseif (is_array($params)) {
                $this->debug("serializing param array for WSDL operation $operation");
                $payload = $this->wsdl->serializeRPCParameters($operation, 'input', $params, $this->bindingType);
            } else {
                $this->debug('params must be array or string');
                $this->setError('params must be array or string');

                return false;
            }
            $usedNamespaces = $this->wsdl->usedNamespaces;
            $encodingStyle  = '';
            if (isset($opData['input']['encodingStyle'])) {
                $encodingStyle = $opData['input']['encodingStyle'];
            }
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            if (false !== ($errstr = $this->wsdl->getError())) {
                $this->debug('got wsdl error: ' . $errstr);
                $this->setError('wsdl error: ' . $errstr);

                return false;
            }
        } elseif ('Wsdl' === $this->endpointType) {
            // operation not in WSDL
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            $this->setError('operation ' . $operation . ' not present in WSDL.');
            $this->debug("operation '$operation' not present in WSDL.");

            return false;
        } else {
            // no WSDL
            //$this->namespaces['ns1'] = $namespace;
            $nsPrefix = 'ns' . mt_rand(1000, 9999);
            // serialize
            $payload = '';
            if (is_string($params)) {
                $this->debug("serializing param string for operation $operation");
                $payload = $params;
            } elseif (is_array($params)) {
                $this->debug("serializing param array for operation $operation");
                foreach ($params as $k => $v) {
                    $payload .= $this->serialize_val($v, $k, false, false, false, false, $use);
                }
            } else {
                $this->debug('params must be array or string');
                $this->setError('params must be array or string');

                return false;
            }
            $usedNamespaces = [];
            $encodingStyle  = '';
            if ('encoded' === $use) {
                $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
            }
        }
        // wrap RPC calls with method element
        if ('rpc' === $style) {
            if ('literal' === $use) {
                $this->debug('wrapping RPC request with literal method element');
                if ($namespace) {
                    // http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html R2735 says rpc/literal accessor elements should not be in a namespace
                    $payload = "<$nsPrefix:$operation xmlns:$nsPrefix=\"$namespace\">" . $payload . "</$nsPrefix:$operation>";
                } else {
                    $payload = "<$operation>" . $payload . "</$operation>";
                }
            } else {
                $this->debug('wrapping RPC request with encoded method element');
                if ($namespace) {
                    $payload = "<$nsPrefix:$operation xmlns:$nsPrefix=\"$namespace\">" . $payload . "</$nsPrefix:$operation>";
                } else {
                    $payload = "<$operation>" . $payload . "</$operation>";
                }
            }
        }
        // serialize envelope
        $soapmsg = $this->serializeEnvelope($payload, $this->requestHeaders, $usedNamespaces, $style, $use, $encodingStyle);
        $this->debug("endpoint=$this->endpoint, soapAction=$soapAction, namespace=$namespace, style=$style, use=$use, encodingStyle=$encodingStyle");
        $this->debug('SOAP message length=' . mb_strlen($soapmsg) . ' contents (max 1000 bytes)=' . mb_substr($soapmsg, 0, 1000));
        // send
        $return = $this->send($this->getHTTPBody($soapmsg), $soapAction, $this->timeout, $this->response_timeout);
        if (false !== ($errstr = $this->getError())) {
            $this->debug('Error: ' . $errstr);

            return false;
        }
        $this->return = $return;

        $this->debug('sent message successfully and got a(n) ' . gettype($return));
        $this->appendDebug('return=' . $this->varDump($return));
        // fault?
        if (is_array($return) && isset($return['faultcode'])) {
            $this->debug('got fault');
            $this->setError($return['faultcode'] . ': ' . $return['faultstring']);
            $this->fault = true;
            foreach ($return as $k => $v) {
                $this->$k = $v;
                if (is_array($v)) {
                    $this->debug("$k = " . json_encode($v));
                } else {
                    $this->debug("$k = $v<br>");
                }
            }

            return $return;
        } elseif ('document' === $style) {
            // NOTE: if the response is defined to have multiple parts (i.e. unwrapped),
            // we are only going to return the first part here...sorry about that
            return $return;
        }
        // array of return values
        if (is_array($return)) {
            // multiple 'out' parameters, which we return wrapped up
            // in the array
            if (is_array($return) && count($return) > 1) {
                return $return;
            }
            // single 'out' parameter (normally the return value)
            $return = array_shift($return);
            $this->debug('return shifted value: ');
            $this->appendDebug($this->varDump($return));

            return $return;
            // nothing returned (ie, echoVoid)
        }

        return '';
    }

    /**
     * Check WSDL passed as an instance or pulled from an endpoint
     */
    private function checkWSDL()
    {
        $this->appendDebug($this->wsdl->getDebug());
        $this->wsdl->clearDebug();
        $this->debug('checkWSDL');
        // catch errors
        if (false !== ($errstr = $this->wsdl->getError())) {
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            $this->debug('got wsdl error: ' . $errstr);
            $this->setError('wsdl error: ' . $errstr);
        } elseif (false !== ($this->operations = $this->wsdl->getOperations($this->portName, 'soap'))) {
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            $this->bindingType = 'soap';
            $this->debug('got ' . count($this->operations) . ' operations from Wsdl ' . $this->wsdlFile . ' for binding type ' . $this->bindingType);
        } elseif (false !== ($this->operations = $this->wsdl->getOperations($this->portName, 'soap12'))) {
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            $this->bindingType = 'soap12';
            $this->debug('got ' . count($this->operations) . ' operations from Wsdl ' . $this->wsdlFile . ' for binding type ' . $this->bindingType);
            $this->debug('**************** WARNING: SOAP 1.2 BINDING *****************');
        } else {
            $this->appendDebug($this->wsdl->getDebug());
            $this->wsdl->clearDebug();
            $this->debug('getOperations returned false');
            $this->setError('no operations defined in the WSDL document!');
        }
    }

    /**
     * Instantiate Wsdl object and parse Wsdl file
     */
    public function loadWSDL()
    {
        $this->debug('instantiating Wsdl class with doc: ' . $this->wsdlFile);
        $this->wsdl = new Wsdl('', $this->proxyhost, $this->proxyport, $this->proxyusername, $this->proxypassword, $this->timeout, $this->response_timeout, $this->curl_options, $this->use_curl);

        $this->wsdl->setCredentials($this->username, $this->password, $this->authtype, $this->certRequest);
        $this->wsdl->fetchWSDL($this->wsdlFile);
        $this->checkWSDL();
    }

    /**
     * Get available data pertaining to an operation
     *
     * @param  string $operation operation name
     * @return   bool|array array of data pertaining to the operation
     */
    public function getOperationData($operation)
    {
        if ('Wsdl' === $this->endpointType && null === $this->wsdl) {
            $this->loadWSDL();
            if ($this->getError()) {
                return false;
            }
        }
        if (isset($this->operations[$operation])) {
            return $this->operations[$operation];
        }
        $this->debug("No data for operation: $operation");
    }

    /**
     * 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 int     $timeout          set connection timeout in seconds
     * @param int     $response_timeout set response timeout in seconds
     * @return mixed   native PHP types.
     */
    private function send($msg, $soapaction = '', $timeout = 0, $response_timeout = 30)
    {
        $this->checkCookies();
        // detect transport
        switch (true) {

            // http(s)
            case preg_match('/^http/', $this->endpoint):
                $this->debug('transporting via HTTP');
                if (true === $this->persistentConnection && is_object($this->persistentConnection)) {

                    $http = $this->persistentConnection;
                } else {
                    $http = new Soap_transport_http($this->endpoint, $this->curl_options, $this->use_curl);
                    if ($this->persistentConnection) {
                        $http->usePersistentConnection();
                    }
                }
                $http->setContentType($this->getHTTPContentType(), $this->getHTTPContentTypeCharset());
                $http->setSOAPAction($soapaction);
                if ($this->proxyhost && $this->proxyport) {
                    $http->setProxy($this->proxyhost, $this->proxyport, $this->proxyusername, $this->proxypassword);
                }
                if ('' !== $this->authtype) {
                    $http->setCredentials($this->username, $this->password, $this->authtype, [], $this->certRequest);
                }
                if ('' !== $this->http_encoding) {

                    $http->setEncoding($this->http_encoding);
                }
                $this->debug('sending message, length=' . mb_strlen($msg));
                if (preg_match('/^http:/', $this->endpoint)) {
                    //if (strpos($this->endpoint,'http:')) {
                    $this->responseData = $http->send($msg, $timeout, $response_timeout, $this->cookies);
                } elseif (preg_match('/^https/', $this->endpoint)) {
                    //} elseif (strpos($this->endpoint,'https:')) {
                    //if (PHP_VERSION == '4.3.0-dev') {
                    //$response = $http->send($msg,$timeout,$response_timeout);
                    //$this->request = $http->outgoing_payload;
                    //$this->response = $http->incoming_payload;
                    //} else
                    $this->responseData = $http->sendHTTPS($msg, $timeout, $response_timeout, $this->cookies);
                    $this->responseData = /** @scrutinizer ignore-deprecated */ $http->sendHTTPS($msg, $timeout, $response_timeout, $this->cookies);
                } else {
                    $this->setError('no http/s in endpoint url');
                }
                $this->request  = $http->outgoing_payload;
                $this->response = $http->incoming_payload;
                $this->appendDebug($http->getDebug());
                $this->UpdateCookies($http->incoming_cookies);
                // save transport object if using persistent connections
                if ($this->persistentConnection) {
                    $http->clearDebug();
                    if (!is_object($this->persistentConnection)) {

                        $this->persistentConnection = $http;
                    }
                }

                if (false !== ($err = $http->getError())) {
                    $this->setError('HTTP Error: ' . $err);

                    return false;
                } elseif ($this->getError()) {
                    return false;
                }
                $this->debug('got response, length=' . mb_strlen($this->responseData) . ' type=' . $http->incoming_headers['content-type']);

                return $this->parseResponse($http->incoming_headers, $this->responseData);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                $this->setError('no transport found, or selected transport is not yet supported!');

                return false;
                break;
        }
    }

    /**
     * Processes SOAP message returned from server
     *
     * @param  array  $headers The HTTP headers
     * @param  string $data    unprocessed response data from server
     * @return mixed  value of the message, decoded into a PHP type
     */
    private function parseResponse($headers, $data)
    {
        $this->debug('Entering parseResponse() for data of length ' . mb_strlen($data) . ' headers:');
        $this->appendDebug($this->varDump($headers));
        if (!isset($headers['content-type'])) {
            $this->setError('Response not of type text/xml (no content-type header)');

            return false;
        }
        if (false === mb_strpos($headers['content-type'], 'text/xml')) {
            $this->setError('Response not of type text/xml: ' . $headers['content-type']);

            return false;
        }
        if (mb_strpos($headers['content-type'], '=')) {
            $enc = str_replace('"', '', mb_substr(mb_strstr($headers['content-type'], '='), 1));
            $this->debug('Got response encoding: ' . $enc);
            $this->xml_encoding = 'US-ASCII';
            if (preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i', $enc)) {
                $this->xml_encoding = mb_strtoupper($enc);
            }
        } else {
            // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
            $this->xml_encoding = 'ISO-8859-1';
        }
        $this->debug('Use encoding: ' . $this->xml_encoding . ' when creating Nusoap_parser');
        $parser = new Nusoap_parser($data, $this->xml_encoding, $this->operations, $this->decode_utf8);
        // add parser debug data to our debug
        $this->appendDebug($parser->getDebug());
        // if parse errors
        if (false !== ($errstr = $parser->getError())) {
            $this->setError($errstr);
            // destroy the parser object
            unset($parser);

            return false;
        }
        // get SOAP headers
        $this->responseHeaders = $parser->getHeaders();
        // get SOAP headers
        $this->responseHeader = $parser->get_soapheader();
        // get decoded message
        $return = $parser->get_soapbody();
        // add document for doclit support
        $this->document = $parser->document;
        // destroy the parser object
        unset($parser);
        // return decode message
        return $return;
    }

    /**
     * Sets user-specified cURL options
     *
     * @param mixed $option The cURL option (always integer?)
     * @param mixed $value  The cURL option value
     */
    public function setCurlOption($option, $value)
    {
        $this->debug("setCurlOption option=$option, value=");
        $this->appendDebug($this->varDump($value));
        $this->curl_options[$option] = $value;
    }

    /**
     * Sets the SOAP endpoint, which can override WSDL
     *
     * @param string $endpoint The endpoint URL to use, or empty string or false to prevent override
     */
    public function setEndpoint($endpoint)
    {
        $this->debug("setEndpoint(\"$endpoint\")");
        $this->forceEndpoint = $endpoint;
    }

    /**
     * Set the SOAP headers
     *
     * @param    mixed $headers String of XML with SOAP header content, or array of Soapval objects for SOAP headers
     */
    public function setHeaders($headers)
    {
        $this->debug('setHeaders headers=');
        $this->appendDebug($this->varDump($headers));
        $this->requestHeaders = $headers;
    }

    /**
     * Get the SOAP response headers (namespace resolution incomplete)
     *
     * @return string
     */
    public function getHeaders()
    {
        return $this->responseHeaders;
    }

    /**
     * Get the SOAP response Header (parsed)
     *
     * @return mixed
     */
    public function getHeader()
    {
        return $this->responseHeader;
    }

    /**
     * Set proxy info here
     *
     * @param string $proxyhost
     * @param string $proxyport
     * @param string $proxyusername
     * @param string $proxypassword
     */
    public function setHTTPProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '')
    {
        $this->proxyhost     = $proxyhost;
        $this->proxyport     = $proxyport;
        $this->proxyusername = $proxyusername;
        $this->proxypassword = $proxypassword;
    }

    /**
     * If authenticating, set user credentials here
     *
     * @param string $username
     * @param string $password
     * @param string $authtype    (basic|digest|certificate|ntlm)
     * @param array  $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)
     */
    public function setCredentials($username, $password, $authtype = 'basic', $certRequest = [])
    {
        $this->debug("setCredentials username=$username authtype=$authtype certRequest=");
        $this->appendDebug($this->varDump($certRequest));
        $this->username    = $username;
        $this->password    = $password;
        $this->authtype    = $authtype;
        $this->certRequest = $certRequest;
    }

    /**
     * Use HTTP encoding
     *
     * @param string $enc HTTP encoding
     */
    public function setHTTPEncoding($enc = 'gzip, deflate')
    {
        $this->debug("setHTTPEncoding(\"$enc\")");
        $this->http_encoding = $enc;
    }

    /**
     * Set whether to try to use cURL connections if possible
     *
     * @param bool $use Whether to try to use cURL
     */
    public function setUseCURL($use)
    {
        $this->debug("setUseCURL($use)");
        $this->use_curl = $use;
    }

    /**
     * Use HTTP persistent connections if possible
     */
    public function useHTTPPersistentConnection()
    {
        $this->debug('useHTTPPersistentConnection');
        $this->persistentConnection = true;
    }

    /**
     * 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.
     *
     * @return bool
     * @deprecated
     */
    public function getDefaultRpcParams()
    {
        return $this->defaultRpcParams;
    }

    /**
     * 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.
     *
     * This is no longer used.
     *
     * @param bool $rpcParams
     * @deprecated
     */
    public function setDefaultRpcParams($rpcParams)
    {
        $this->defaultRpcParams = $rpcParams;
    }

    /**
     * Dynamically creates an instance of a proxy class,
     * allowing user to directly call methods from Wsdl
     *
     * @return object soap_proxy object
     */
    public function getProxy()
    {
        $r       = mt_rand();
        $evalStr = $this->_getProxyClassCode($r);
        //$this->debug("proxy class: $evalStr");
        if ($this->getError()) {
            $this->debug('Error from _getProxyClassCode, so return null');

            return null;
        }
        // eval the class
        eval($evalStr);

        // instantiate proxy object
        eval("\$proxy = new Nusoap_proxy_$r('');");

        // transfer current Wsdl data to the proxy thereby avoiding parsing the Wsdl twice
        $proxy->endpointType     = 'Wsdl';

        $proxy->wsdlFile         = $this->wsdlFile;
        $proxy->wsdl             = $this->wsdl;
        $proxy->operations       = $this->operations;
        $proxy->defaultRpcParams = $this->defaultRpcParams;
        // transfer other state
        $proxy->soap_defencoding     = $this->soap_defencoding;
        $proxy->username             = $this->username;
        $proxy->password             = $this->password;
        $proxy->authtype             = $this->authtype;
        $proxy->certRequest          = $this->certRequest;
        $proxy->requestHeaders       = $this->requestHeaders;
        $proxy->endpoint             = $this->endpoint;
        $proxy->forceEndpoint        = $this->forceEndpoint;
        $proxy->proxyhost            = $this->proxyhost;
        $proxy->proxyport            = $this->proxyport;
        $proxy->proxyusername        = $this->proxyusername;
        $proxy->proxypassword        = $this->proxypassword;
        $proxy->http_encoding        = $this->http_encoding;
        $proxy->timeout              = $this->timeout;
        $proxy->response_timeout     = $this->response_timeout;
        $proxy->persistentConnection = $this->persistentConnection;
        $proxy->decode_utf8          = $this->decode_utf8;
        $proxy->curl_options         = $this->curl_options;
        $proxy->bindingType          = $this->bindingType;
        $proxy->use_curl             = $this->use_curl;

        return $proxy;
    }

    /**
     * Dynamically creates proxy class code
     *
     * @param string $r
     * @return string PHP/NuSOAP code for the proxy class
     */
    private function _getProxyClassCode($r)
    {
        $this->debug("in getProxy endpointType=$this->endpointType");
        $this->appendDebug('Wsdl=' . $this->varDump($this->wsdl));
        if ('Wsdl' !== $this->endpointType) {
            $evalStr = 'A proxy can only be created for a WSDL client';
            $this->setError($evalStr);
            $evalStr = "echo \"$evalStr\";";

            return $evalStr;
        }
        if ('Wsdl' === $this->endpointType && null === $this->wsdl) {
            $this->loadWSDL();
            if ($this->getError()) {
                return 'echo "' . $this->getError() . '";';
            }
        }
        $evalStr = '';
        foreach ($this->operations as $operation => $opData) {
            if ('' !== $operation) {
                // create param string and param comment string
                if (is_array($opData['input']['parts']) && count($opData['input']['parts']) > 0) {
                    $paramStr        = '';
                    $paramArrayStr   = '';
                    $paramCommentStr = '';
                    foreach ($opData['input']['parts'] as $name => $type) {
                        $paramStr        .= "\$$name, ";
                        $paramArrayStr   .= "'$name' => \$$name, ";
                        $paramCommentStr .= "$type \$$name, ";
                    }
                    $paramStr        = mb_substr($paramStr, 0, -2);
                    $paramArrayStr   = mb_substr($paramArrayStr, 0, -2);
                    $paramCommentStr = mb_substr($paramCommentStr, 0, -2);
                } else {
                    $paramStr        = '';
                    $paramArrayStr   = '';
                    $paramCommentStr = 'void';
                }
                $opData['namespace'] = !isset($opData['namespace']) ? 'http://testuri.com' : $opData['namespace'];
                $evalStr             .= "// $paramCommentStr
    function " . str_replace('.', '__', $operation) . "($paramStr) {
        \$params = array($paramArrayStr);
        return \$this->call('$operation', \$params, '" . $opData['namespace'] . "', '" . (isset($opData['soapAction']) ? $opData['soapAction'] : '') . "');
    }
    ";
                unset($paramStr, $paramCommentStr);
            }
        }
        $evalStr = 'class Nusoap_proxy_' . $r . ' extends Nusoap_client {
    ' . $evalStr . '
}';

        return $evalStr;
    }

    /**
     * Dynamically creates proxy class code
     *
     * @return string PHP/NuSOAP code for the proxy class
     */
    public function getProxyClassCode()
    {
        $r = mt_rand();

        return $this->_getProxyClassCode($r);
    }

    /**
     * Gets the HTTP body for the current request.
     *
     * @param  string $soapmsg The SOAP payload
     * @return string The HTTP body, which includes the SOAP payload
     */
    private function getHTTPBody($soapmsg)
    {
        return $soapmsg;
    }

    /**
     * Gets the HTTP content type for the current request.
     *
     * Note: getHTTPBody must be called before this.
     *
     * @return string the HTTP content type for the current request.
     */
    private function getHTTPContentType()
    {
        return 'text/xml';
    }

    /**
     * Gets the HTTP content type charset for the current request.
     * Returns false for non-text content types.
     *
     * Note: getHTTPBody must be called before this.
     *
     * @return string the HTTP content type charset for the current request.
     */
    private function getHTTPContentTypeCharset()
    {
        return $this->soap_defencoding;
    }

    /*
    * Whether or not parser should decode utf8 element content
    *
    * @return   always returns true
    * @access   public
    */

    /**
     * @param $bool
     * @return bool
     */
    public function decodeUTF8($bool)
    {
        $this->decode_utf8 = $bool;

        return true;
    }

    /**
     * Adds a new Cookie into $this->cookies array
     *
     * @param  string $name  Cookie Name
     * @param  string $value Cookie Value
     * @return bool if cookie-set was successful returns true, else false
     */
    public function setCookie($name, $value)
    {
        if ('' === $name) {
            return false;
        }
        $this->cookies[] = ['name' => $name, 'value' => $value];

        return true;
    }

    /**
     * Gets all Cookies
     *
     * @return array with all internal cookies
     */
    public function getCookies()
    {
        return $this->cookies;
    }

    /**
     * Checks all Cookies and delete those which are expired
     *
     * @return bool always return true
     */
    private function checkCookies()
    {
        if (0 === count($this->cookies)) {
            return true;
        }
        $this->debug('checkCookie: check ' . count($this->cookies) . ' cookies');
        $curr_cookies  = $this->cookies;
        $this->cookies = [];
        foreach ($curr_cookies as $cookie) {
            if (!is_array($cookie)) {
                $this->debug('Remove cookie that is not an array');
                continue;
            }
            if (isset($cookie['expires']) && !empty($cookie['expires'])) {
                if (strtotime($cookie['expires']) > time()) {
                    $this->cookies[] = $cookie;
                } else {
                    $this->debug('Remove expired cookie ' . $cookie['name']);
                }
            } else {
                $this->cookies[] = $cookie;
            }
        }
        $this->debug('checkCookie: ' . count($this->cookies) . ' cookies left in array');

        return true;
    }

    /**
     * Updates the current cookies with a new set
     *
     * @param  array $cookies new cookies with which to update current ones
     * @return bool always return true
     */
    private function UpdateCookies($cookies)
    {
        if (0 === count($this->cookies)) {
            // no existing cookies: take whatever is new
            if ($cookies && is_array($cookies)) {

                $this->debug('Setting new cookie(s)');
                $this->cookies = $cookies;
            }

            return true;
        }
        if (0 === count($cookies)) {
            // no new cookies: keep what we've got
            return true;
        }
        // merge
        foreach ($cookies as $newCookie) {
            if (!is_array($newCookie)) {
                continue;
            }
            if (!isset($newCookie['name']) || !isset($newCookie['value'])) {
                continue;
            }
            $newName = $newCookie['name'];
            $found   = false;
            for ($i = 0, $iMax = count($this->cookies); $i < $iMax; ++$i) {
                $cookie = $this->cookies[$i];
                if (!is_array($cookie)) {
                    continue;
                }
                if (!isset($cookie['name'])) {
                    continue;
                }
                if ($newName !== $cookie['name']) {
                    continue;
                }
                $newDomain = isset($newCookie['domain']) ? $newCookie['domain'] : 'NODOMAIN';
                $domain    = isset($cookie['domain']) ? $cookie['domain'] : 'NODOMAIN';
                if ($newDomain !== $domain) {
                    continue;
                }
                $newPath = isset($newCookie['path']) ? $newCookie['path'] : 'NOPATH';
                $path    = isset($cookie['path']) ? $cookie['path'] : 'NOPATH';
                if ($newPath !== $path) {
                    continue;
                }
                $this->cookies[$i] = $newCookie;
                $found             = true;
                $this->debug('Update cookie ' . $newName . '=' . $newCookie['value']);
                break;
            }
            if (!$found) {
                $this->debug('Add cookie ' . $newName . '=' . $newCookie['value']);
                $this->cookies[] = $newCookie;
            }
        }

        return true;
    }
}

if (!extension_loaded('soap')) {
    /**
     *    For backwards compatiblity, define Soapclient unless the PHP SOAP extension is loaded.
     */
    class Soapclient extends Nusoap_client
    {
    }
}

XoopsModules25x / oledrion

Issues (608)

Security Analysis not enabled

class/Gateways/Pec24/nusoap.php (149 issues)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like
