<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Soap

 * @subpackage Client

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Client.php 24593 2012-01-05 20:35:02Z matthew $

 */

/**

 * @see Zend_Soap_Server

 */

require_once 'Zend/Soap/Server.php';

/**

 * @see Zend_Soap_Client_Local

 */

require_once 'Zend/Soap/Client/Local.php';

/**

 * @see Zend_Soap_Client_Common

 */

require_once 'Zend/Soap/Client/Common.php';

/**

 * Zend_Soap_Client

 *

 * @category   Zend

 * @package    Zend_Soap

 * @subpackage Client

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Soap_Client

{

    /**

     * Encoding

     * @var string

     */

    protected $_encoding = 'UTF-8';

    /**

     * Array of SOAP type => PHP class pairings for handling return/incoming values

     * @var array

     */

    protected $_classmap = null;

    /**

     * Registered fault exceptions

     * @var array

     */

    protected $_faultExceptions = array();

    /**

     * SOAP version to use; SOAP_1_2 by default, to allow processing of headers

     * @var int

     */

    protected $_soapVersion = SOAP_1_2;

    /** Set of other SoapClient options */

    protected $_uri                 = null;

    protected $_location            = null;

    protected $_style               = null;

    protected $_use                 = null;

    protected $_login               = null;

    protected $_password            = null;

    protected $_proxy_host          = null;

    protected $_proxy_port          = null;

    protected $_proxy_login         = null;

    protected $_proxy_password      = null;

    protected $_local_cert          = null;

    protected $_passphrase          = null;

    protected $_compression         = null;

    protected $_connection_timeout  = null;

    protected $_stream_context      = null;

    protected $_features            = null;

    protected $_cache_wsdl          = null;

    protected $_user_agent          = null;

    /**

     * WSDL used to access server

     * It also defines Zend_Soap_Client working mode (WSDL vs non-WSDL)

     *

     * @var string

     */

    protected $_wsdl = null;

    /**

     * SoapClient object

     *

     * @var SoapClient

     */

    protected $_soapClient;

    /**

     * Last invoked method

     *

     * @var string

     */

    protected $_lastMethod = '';

    /**

     * SOAP request headers.

     *

     * Array of SoapHeader objects

     *

     * @var array

     */

    protected $_soapInputHeaders = array();

    /**

     * Permanent SOAP request headers (shared between requests).

     *

     * Array of SoapHeader objects

     *

     * @var array

     */

    protected $_permanentSoapInputHeaders = array();

    /**

     * Output SOAP headers.

     *

     * Array of SoapHeader objects

     *

     * @var array

     */

    protected $_soapOutputHeaders = array();

    /**

     * Constructor

     *

     * @param string $wsdl

     * @param array $options

     */

    public function __construct($wsdl = null, $options = null)

    {

        if (!extension_loaded('soap')) {

            require_once 'Zend/Soap/Client/Exception.php';

            throw new Zend_Soap_Client_Exception('SOAP extension is not loaded.');

        }

        if ($wsdl !== null) {

            $this->setWsdl($wsdl);

        }

        if ($options !== null) {

            $this->setOptions($options);

        }

    }

    /**

     * Set wsdl

     *

     * @param string $wsdl

     * @return Zend_Soap_Client

     */

    public function setWsdl($wsdl)

    {

        $this->_wsdl = $wsdl;

        $this->_soapClient = null;

        return $this;

    }

    /**

     * Get wsdl

     *

     * @return string

     */

    public function getWsdl()

    {

        return $this->_wsdl;

    }

    /**

     * Set Options

     *

     * Allows setting options as an associative array of option => value pairs.

     *

     * @param  array|Zend_Config $options

     * @return Zend_Soap_Client

     * @throws Zend_SoapClient_Exception

     */

    public function setOptions($options)

    {

        if($options instanceof Zend_Config) {

            $options = $options->toArray();

        }

        foreach ($options as $key => $value) {

            switch ($key) {

                case 'classmap':

                case 'classMap':

                    $this->setClassmap($value);

                    break;

                case 'encoding':

                    $this->setEncoding($value);

                    break;

                case 'soapVersion':

                case 'soap_version':

                    $this->setSoapVersion($value);

                    break;

                case 'wsdl':

                    $this->setWsdl($value);

                    break;

                case 'uri':

                    $this->setUri($value);

                    break;

                case 'location':

                    $this->setLocation($value);

                    break;

                case 'style':

                    $this->setStyle($value);

                    break;

                case 'use':

                    $this->setEncodingMethod($value);

                    break;

                case 'login':

                    $this->setHttpLogin($value);

                    break;

                case 'password':

                    $this->setHttpPassword($value);

                    break;

                case 'proxy_host':

                    $this->setProxyHost($value);

                    break;

                case 'proxy_port':

                    $this->setProxyPort($value);

                    break;

                case 'proxy_login':

                    $this->setProxyLogin($value);

                    break;

                case 'proxy_password':

                    $this->setProxyPassword($value);

                    break;

                case 'local_cert':

                    $this->setHttpsCertificate($value);

                    break;

                case 'passphrase':

                    $this->setHttpsCertPassphrase($value);

                    break;

                case 'compression':

                    $this->setCompressionOptions($value);

                    break;

                case 'stream_context':

                    $this->setStreamContext($value);

                    break;

                case 'features':

                    $this->setSoapFeatures($value);

                    break;

                case 'cache_wsdl':

                    $this->setWsdlCache($value);

                    break;

                case 'useragent':

                case 'userAgent':

                case 'user_agent':

                    $this->setUserAgent($value);

                    break;

                // Not used now

                // case 'connection_timeout':

                //     $this->_connection_timeout = $value;

                //    break;

                default:

                    require_once 'Zend/Soap/Client/Exception.php';

                    throw new Zend_Soap_Client_Exception('Unknown SOAP client option');

                    break;

            }

        }

        return $this;

    }

    /**

     * Return array of options suitable for using with SoapClient constructor

     *

     * @return array

     */

    public function getOptions()

    {

        $options = array();

        $options['classmap']       = $this->getClassmap();

        $options['encoding']       = $this->getEncoding();

        $options['soap_version']   = $this->getSoapVersion();

        $options['wsdl']           = $this->getWsdl();

        $options['uri']            = $this->getUri();

        $options['location']       = $this->getLocation();

        $options['style']          = $this->getStyle();

        $options['use']            = $this->getEncodingMethod();

        $options['login']          = $this->getHttpLogin();

        $options['password']       = $this->getHttpPassword();

        $options['proxy_host']     = $this->getProxyHost();

        $options['proxy_port']     = $this->getProxyPort();

        $options['proxy_login']    = $this->getProxyLogin();

        $options['proxy_password'] = $this->getProxyPassword();

        $options['local_cert']     = $this->getHttpsCertificate();

        $options['passphrase']     = $this->getHttpsCertPassphrase();

        $options['compression']    = $this->getCompressionOptions();

        //$options['connection_timeout'] = $this->_connection_timeout;

        $options['stream_context'] = $this->getStreamContext();

        $options['cache_wsdl']     = $this->getWsdlCache();

        $options['features']       = $this->getSoapFeatures();

        $options['user_agent']     = $this->getUserAgent();

        foreach ($options as $key => $value) {

            /*

             * ugly hack as I don't know if checking for '=== null'

             * breaks some other option

             */

            if (in_array($key, array('user_agent', 'cache_wsdl', 'compression'))) {

                if ($value === null) {

                    unset($options[$key]);

                }

            } else {

                if ($value == null) {

                    unset($options[$key]);

                }

            }

        }

        return $options;

    }

    /**

     * Set SOAP version

     *

     * @param  int $version One of the SOAP_1_1 or SOAP_1_2 constants

     * @return Zend_Soap_Client

     * @throws Zend_Soap_Client_Exception with invalid soap version argument

     */

    public function setSoapVersion($version)

    {

        if (!in_array($version, array(SOAP_1_1, SOAP_1_2))) {

            require_once 'Zend/Soap/Client/Exception.php';

            throw new Zend_Soap_Client_Exception('Invalid soap version specified. Use SOAP_1_1 or SOAP_1_2 constants.');

        }

        $this->_soapVersion = $version;

        $this->_soapClient = null;

        return $this;

    }

    /**

     * Get SOAP version

     *

     * @return int

     */

    public function getSoapVersion()

    {

        return $this->_soapVersion;

    }

    /**

     * Set classmap

     *

     * @param  array $classmap

     * @return Zend_Soap_Client

     * @throws Zend_Soap_Client_Exception for any invalid class in the class map

     */

    public function setClassmap(array $classmap)

    {

        foreach ($classmap as $type => $class) {

            if (!class_exists($class)) {

                require_once 'Zend/Soap/Client/Exception.php';

                throw new Zend_Soap_Client_Exception('Invalid class in class map');

            }

        }

        $this->_classmap = $classmap;

        $this->_soapClient = null;

        return $this;

    }

    /**

     * Retrieve classmap

     *

     * @return mixed

     */

    public function getClassmap()

    {

        return $this->_classmap;

    }

    /**

     * Set encoding

     *

     * @param  string $encoding

     * @return Zend_Soap_Client

     * @throws Zend_Soap_Client_Exception with invalid encoding argument

     */

    public function setEncoding($encoding)

    {

        if (!is_string($encoding)) {

            require_once 'Zend/Soap/Client/Exception.php';

            throw new Zend_Soap_Client_Exception('Invalid encoding specified');

        }

        $this->_encoding = $encoding;

        $this->_soapClient = null;

        return $this;

    }

    /**

     * Get encoding

     *

     * @return string

     */

    public function getEncoding()

    {

        return $this->_encoding;

    }

    /**

     * Check for valid URN

     *

     * @param  string $urn

     * @return true

     * @throws Zend_Soap_Client_Exception on invalid URN

     */

    public function validateUrn($urn)

    {

        $scheme = parse_url($urn, PHP_URL_SCHEME);

        if ($scheme === false || $scheme === null) {

            require_once 'Zend/Soap/Client/Exception.php';

            throw new Zend_Soap_Client_Exception('Invalid URN');

        }

        return true;

    }