<?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 Server

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

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

 */

/**

 * @see Zend_Server_Interface

 */

require_once 'Zend/Server/Interface.php';

/**

 * Zend_Soap_Server

 *

 * @category   Zend

 * @package    Zend_Soap

 * @subpackage Server

 * @uses       Zend_Server_Interface

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

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

 * @version    $Id: Server.php 22223 2010-05-21 08:06:47Z jan $

 */

class Zend_Soap_Server implements Zend_Server_Interface

{

    /**

     * Actor URI

     * @var string URI

     */

    protected $_actor;

    /**

     * Class registered with this server

     * @var string

     */

    protected $_class;

    /**

     * Arguments to pass to {@link $_class} constructor

     * @var array

     */

    protected $_classArgs = array();

    /**

     * Object registered with this server

     */

    protected $_object;

    /**

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

     * @var array

     */

    protected $_classmap;

    /**

     * Encoding

     * @var string

     */

    protected $_encoding;

    /**

     * SOAP Server Features

     *

     * @var int

     */

    protected $_features;

    /**

     * WSDL Caching Options of SOAP Server

     *

     * @var mixed

     */

    protected $_wsdlCache;

    /**

     * Registered fault exceptions

     * @var array

     */

    protected $_faultExceptions = array();

    /**

     * Functions registered with this server; may be either an array or the SOAP_FUNCTIONS_ALL

     * constant

     * @var array|int

     */

    protected $_functions = array();

    /**

     * Persistence mode; should be one of the SOAP persistence constants

     * @var int

     */

    protected $_persistence;

    /**

     * Request XML

     * @var string

     */

    protected $_request;

    /**

     * Response XML

     * @var string

     */

    protected $_response;

    /**

     * Flag: whether or not {@link handle()} should return a response instead

     * of automatically emitting it.

     * @var boolean

     */

    protected $_returnResponse = false;

    /**

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

     * @var int

     */

    protected $_soapVersion = SOAP_1_2;

    /**

     * URI or path to WSDL

     * @var string

     */

    protected $_wsdl;

    /**

     * URI namespace for SOAP server

     * @var string URI

     */

    protected $_uri;

    /**

     * Constructor

     *

     * Sets display_errors INI setting to off (prevent client errors due to bad

     * XML in response). Registers {@link handlePhpErrors()} as error handler

     * for E_USER_ERROR.

     *

     * If $wsdl is provided, it is passed on to {@link setWsdl()}; if any

     * options are specified, they are passed on to {@link setOptions()}.

     *

     * @param string $wsdl

     * @param array $options

     * @return void

     */

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

    {

        if (!extension_loaded('soap')) {

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

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

        }

        if (null !== $wsdl) {

            $this->setWsdl($wsdl);

        }

        if (null !== $options) {

            $this->setOptions($options);

        }

    }

    /**

     * Set Options

     *

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

     *

     * @param  array|Zend_Config $options

     * @return Zend_Soap_Server

     */

    public function setOptions($options)

    {

        if($options instanceof Zend_Config) {

            $options = $options->toArray();

        }

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

            switch ($key) {

                case 'actor':

                    $this->setActor($value);

                    break;

                case 'classmap':

                case 'classMap':

                    $this->setClassmap($value);

                    break;

                case 'encoding':

                    $this->setEncoding($value);

                    break;

                case 'soapVersion':

                case 'soap_version':

                    $this->setSoapVersion($value);

                    break;

                case 'uri':

                    $this->setUri($value);

                    break;

                case 'wsdl':

                    $this->setWsdl($value);

                    break;

                case 'featues':

                    trigger_error(__METHOD__ . ': the option "featues" is deprecated as of 1.10.x and will be removed with 2.0.0; use "features" instead', E_USER_NOTICE);

                case 'features':

                    $this->setSoapFeatures($value);

                    break;

                case 'cache_wsdl':

                    $this->setWsdlCache($value);

                    break;

                default:

                    break;

            }

        }

        return $this;

    }

    /**

     * Return array of options suitable for using with SoapServer constructor

     *

     * @return array

     */

    public function getOptions()

    {

        $options = array();

        if (null !== $this->_actor) {

            $options['actor'] = $this->_actor;

        }

        if (null !== $this->_classmap) {

            $options['classmap'] = $this->_classmap;

        }

        if (null !== $this->_encoding) {

            $options['encoding'] = $this->_encoding;

        }

        if (null !== $this->_soapVersion) {

            $options['soap_version'] = $this->_soapVersion;

        }

        if (null !== $this->_uri) {

            $options['uri'] = $this->_uri;

        }

        if(null !== $this->_features) {

            $options['features'] = $this->_features;

        }

        if(null !== $this->_wsdlCache) {

            $options['cache_wsdl'] = $this->_wsdlCache;

        }

        return $options;

    }

    /**

     * Set encoding

     *

     * @param  string $encoding

     * @return Zend_Soap_Server

     * @throws Zend_Soap_Server_Exception with invalid encoding argument

     */

    public function setEncoding($encoding)

    {

        if (!is_string($encoding)) {

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

            throw new Zend_Soap_Server_Exception('Invalid encoding specified');

        }

        $this->_encoding = $encoding;

        return $this;

    }

    /**

     * Get encoding

     *

     * @return string

     */

    public function getEncoding()

    {

        return $this->_encoding;

    }

    /**

     * Set SOAP version

     *

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

     * @return Zend_Soap_Server

     * @throws Zend_Soap_Server_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/Server/Exception.php';

            throw new Zend_Soap_Server_Exception('Invalid soap version specified');

        }

        $this->_soapVersion = $version;

        return $this;

    }

    /**

     * Get SOAP version

     *

     * @return int

     */

    public function getSoapVersion()

    {

        return $this->_soapVersion;

    }

    /**

     * Check for valid URN

     *

     * @param  string $urn

     * @return true

     * @throws Zend_Soap_Server_Exception on invalid URN

     */

    public function validateUrn($urn)

    {

        $scheme = parse_url($urn, PHP_URL_SCHEME);

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

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

            throw new Zend_Soap_Server_Exception('Invalid URN');

        }

        return true;

    }

    /**

     * Set actor

     *

     * Actor is the actor URI for the server.

     *

     * @param  string $actor

     * @return Zend_Soap_Server

     */

    public function setActor($actor)

    {

        $this->validateUrn($actor);

        $this->_actor = $actor;

        return $this;

    }

    /**

     * Retrieve actor

     *

     * @return string

     */

    public function getActor()

    {

        return $this->_actor;

    }

    /**

     * Set URI

     *

     * URI in SoapServer is actually the target namespace, not a URI; $uri must begin with 'urn:'.

     *

     * @param  string $uri

     * @return Zend_Soap_Server

     * @throws Zend_Soap_Server_Exception with invalid uri argument

     */

    public function setUri($uri)

    {

        $this->validateUrn($uri);

        $this->_uri = $uri;

        return $this;

    }

    /**

     * Retrieve URI

     *

     * @return string

     */

    public function getUri()

    {

        return $this->_uri;

    }

    /**

     * Set classmap

     *

     * @param  array $classmap

     * @return Zend_Soap_Server

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

     */

    public function setClassmap($classmap)

    {

        if (!is_array($classmap)) {

            /**

             * @see Zend_Soap_Server_Exception

             */

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

            throw new Zend_Soap_Server_Exception('Classmap must be an array');

        }

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

            if (!class_exists($class)) {

                /**

                 * @see Zend_Soap_Server_Exception

                 */

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

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

            }

        }

        $this->_classmap = $classmap;

        return $this;

    }

    /**

     * Retrieve classmap

     *

     * @return mixed

     */

    public function getClassmap()

    {

        return $this->_classmap;

    }

    /**

     * Set wsdl

     *

     * @param string $wsdl  URI or path to a WSDL

     * @return Zend_Soap_Server

     */

    public function setWsdl($wsdl)

    {

        $this->_wsdl = $wsdl;

        return $this;

    }

    /**

     * Retrieve wsdl

     *

     * @return string

     */

    public function getWsdl()

    {

        return $this->_wsdl;

    }

    /**

     * Set the SOAP Feature options.

     *

     * @param  string|int $feature

     * @return Zend_Soap_Server

     */

    public function setSoapFeatures($feature)

    {

        $this->_features = $feature;

        return $this;