Zend_Soap_AutoDiscover Class Reference

Inheritance diagram for Zend_Soap_AutoDiscover:

Public Member Functions
	__construct ($strategy=true, $uri=null, $wsdlClass=null)
	setUri ($uri)
	getUri ()
	setWsdlClass ($wsdlClass)
	getWsdlClass ()
	setOperationBodyStyle (array $operationStyle=array())
	setBindingStyle (array $bindingStyle=array())
	setComplexTypeStrategy ($strategy)
	setClass ($class, $namespace='', $argv=null)
	addFunction ($function, $namespace='')
	fault ($fault=null, $code=null)
	handle ($request=false)
	dump ($filename)
	toXml ()
	getFunctions ()
	loadFunctions ($definition)
	setPersistence ($mode)
	getType ($type)

Protected Member Functions
	getSchema ()
	getHostName ()
	getRequestUriWithoutParameters ()
	_addFunctionToWsdl ($function, $wsdl, $port, $binding)

Protected Attributes
	$_wsdl = null
	$_reflection = null
	$_functions = array()
	$_strategy
	$_uri
	$_operationBodyStyle = array('use' => 'encoded', 'encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/")
	$_bindingStyle = array('style' => 'rpc', 'transport' => 'http://schemas.xmlsoap.org/soap/http')
	$_wsdlClass = 'Zend_Soap_Wsdl'

Detailed Description

Definition at line 51 of file AutoDiscover.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$strategy = true,
			$uri = null,
			$wsdlClass = null
	)

Constructor

Parameters

boolean | string | Zend_Soap_Wsdl_Strategy_Interface	$strategy
string | Zend_Uri	$uri
string	$wsdlClass

Definition at line 108 of file AutoDiscover.php.

    {
        $this->_reflection = new Zend_Server_Reflection();
        $this->setComplexTypeStrategy($strategy);

        if($uri !== null) {
            $this->setUri($uri);
        }

        if($wsdlClass !== null) {
            $this->setWsdlClass($wsdlClass);
        }
    }

Member Function Documentation

_addFunctionToWsdl()

_addFunctionToWsdl (   $function,   $wsdl,   $port,   $binding  )

protected

Add a function to the WSDL document.

Parameters

Zend_Server_Reflection_Function_Abstract	$function	function to add
Zend_Soap_Wsdl	$wsdl	WSDL document
object	$port	wsdl:portType
object	$binding	wsdl:binding

Returns

void

Definition at line 389 of file AutoDiscover.php.

    {
        $uri = $this->getUri();

        // We only support one prototype: the one with the maximum number of arguments
        $prototype = null;
        $maxNumArgumentsOfPrototype = -1;
        foreach ($function->getPrototypes() as $tmpPrototype) {
            $numParams = count($tmpPrototype->getParameters());
            if ($numParams > $maxNumArgumentsOfPrototype) {
                $maxNumArgumentsOfPrototype = $numParams;
                $prototype = $tmpPrototype;
            }
        }
        if ($prototype === null) {
            #require_once "Zend/Soap/AutoDiscover/Exception.php";
            throw new Zend_Soap_AutoDiscover_Exception("No prototypes could be found for the '" . $function->getName() . "' function");
        }

        // Add the input message (parameters)
        $args = array();
        if ($this->_bindingStyle['style'] == 'document') {
            // Document style: wrap all parameters in a sequence element
            $sequence = array();
            foreach ($prototype->getParameters() as $param) {
                $sequenceElement = array(
                    'name' => $param->getName(),
                    'type' => $wsdl->getType($param->getType())
                );
                if ($param->isOptional()) {
                    $sequenceElement['nillable'] = 'true';
                }
                $sequence[] = $sequenceElement;
            }
            $element = array(
                'name' => $function->getName(),
                'sequence' => $sequence
            );
            // Add the wrapper element part, which must be named 'parameters'
            $args['parameters'] = array('element' => $wsdl->addElement($element));
        } else {
            // RPC style: add each parameter as a typed part
            foreach ($prototype->getParameters() as $param) {
                $args[$param->getName()] = array('type' => $wsdl->getType($param->getType()));
            }
        }
        $wsdl->addMessage($function->getName() . 'In', $args);

        $isOneWayMessage = false;
        if($prototype->getReturnType() == "void") {
            $isOneWayMessage = true;
        }

        if($isOneWayMessage == false) {
            // Add the output message (return value)
            $args = array();
            if ($this->_bindingStyle['style'] == 'document') {
                // Document style: wrap the return value in a sequence element
                $sequence = array();
                if ($prototype->getReturnType() != "void") {
                    $sequence[] = array(
                        'name' => $function->getName() . 'Result',
                        'type' => $wsdl->getType($prototype->getReturnType())
                    );
                }
                $element = array(
                    'name' => $function->getName() . 'Response',
                    'sequence' => $sequence
                );
                // Add the wrapper element part, which must be named 'parameters'
                $args['parameters'] = array('element' => $wsdl->addElement($element));
            } else if ($prototype->getReturnType() != "void") {
                // RPC style: add the return value as a typed part
                $args['return'] = array('type' => $wsdl->getType($prototype->getReturnType()));
            }
            $wsdl->addMessage($function->getName() . 'Out', $args);
        }

        // Add the portType operation
        if($isOneWayMessage == false) {
            $portOperation = $wsdl->addPortOperation($port, $function->getName(), 'tns:' . $function->getName() . 'In', 'tns:' . $function->getName() . 'Out');
        } else {
            $portOperation = $wsdl->addPortOperation($port, $function->getName(), 'tns:' . $function->getName() . 'In', false);
        }
        $desc = $function->getDescription();
        if (strlen($desc) > 0) {
            $wsdl->addDocumentation($portOperation, $desc);
        }

        // When using the RPC style, make sure the operation style includes a 'namespace' attribute (WS-I Basic Profile 1.1 R2717)
        if ($this->_bindingStyle['style'] == 'rpc' && !isset($this->_operationBodyStyle['namespace'])) {
            $this->_operationBodyStyle['namespace'] = ''.$uri;
        }

        // Add the binding operation
        if($isOneWayMessage == false) {
            $operation = $wsdl->addBindingOperation($binding, $function->getName(),  $this->_operationBodyStyle, $this->_operationBodyStyle);
        } else {
            $operation = $wsdl->addBindingOperation($binding, $function->getName(),  $this->_operationBodyStyle);
        }
        $wsdl->addSoapOperation($operation, $uri . '#' .$function->getName());

        // Add the function name to the list
        $this->_functions[] = $function->getName();
    }

addFunction()

addFunction	(		$function,
			$namespace = ''
	)

Add a Single or Multiple Functions to the WSDL

Parameters

string	$function	Function Name
string	$namespace	Function namespace - Not Used

Returns

Zend_Soap_AutoDiscover

Implements Zend_Server_Interface.

Definition at line 342 of file AutoDiscover.php.

    {
        static $port;
        static $operation;
        static $binding;

        if (!is_array($function)) {
            $function = (array) $function;
        }

        $uri = $this->getUri();

        if (!($this->_wsdl instanceof Zend_Soap_Wsdl)) {
            $parts = explode('.', basename($_SERVER['SCRIPT_NAME']));
            $name = $parts[0];
            $wsdl = new Zend_Soap_Wsdl($name, $uri, $this->_strategy);

            // The wsdl:types element must precede all other elements (WS-I Basic Profile 1.1 R2023)
            $wsdl->addSchemaTypeSection();

            $port = $wsdl->addPortType($name . 'Port');
            $binding = $wsdl->addBinding($name . 'Binding', 'tns:' .$name. 'Port');

            $wsdl->addSoapBinding($binding, $this->_bindingStyle['style'], $this->_bindingStyle['transport']);
            $wsdl->addService($name . 'Service', $name . 'Port', 'tns:' . $name . 'Binding', $uri);
        } else {
            $wsdl = $this->_wsdl;
        }

        foreach ($function as $func) {
            $method = $this->_reflection->reflectFunction($func);
            $this->_addFunctionToWsdl($method, $wsdl, $port, $binding);
        }
        $this->_wsdl = $wsdl;

        return $this;
    }

dump()

dump

(

$filename

)

Proxy to WSDL dump function

Parameters

string

$filename

Returns

boolean

Exceptions

Zend_Soap_AutoDiscover_Exception

See also

Zend_Soap_AutoDiscover_Exception

Definition at line 528 of file AutoDiscover.php.

    {
        if($this->_wsdl !== null) {
            return $this->_wsdl->dump($filename);
        } else {
            #require_once "Zend/Soap/AutoDiscover/Exception.php";
            throw new Zend_Soap_AutoDiscover_Exception("Cannot dump autodiscovered contents, WSDL file has not been generated yet.");
        }
    }

fault()

fault	(		$fault = null,
			$code = null
	)

Action to take when an error occurs

Parameters

string	$fault
string | int	$code

Exceptions

Zend_Soap_AutoDiscover_Exception

Implements Zend_Server_Interface.

Definition at line 502 of file AutoDiscover.php.

    {
        #require_once "Zend/Soap/AutoDiscover/Exception.php";
        throw new Zend_Soap_AutoDiscover_Exception("Function has no use in AutoDiscover.");
    }

getFunctions()

getFunctions

(

)

Return an array of functions in the WSDL

Returns

array

Implements Zend_Server_Interface.

Definition at line 565 of file AutoDiscover.php.

    {
        return $this->_functions;
    }

getHostName()

getHostName ( )

protected

Detect and return the current hostname

Returns

string

Definition at line 254 of file AutoDiscover.php.

    {
        if(isset($_SERVER['HTTP_HOST'])) {
            $host = $_SERVER['HTTP_HOST'];
        } else {
            $host = $_SERVER['SERVER_NAME'];
        }
        return $host;
    }

getRequestUriWithoutParameters()

getRequestUriWithoutParameters ( )

protected

Detect and return the current script name without parameters

Returns

string

Definition at line 269 of file AutoDiscover.php.

    {
        if (isset($_SERVER['HTTP_X_ORIGINAL_URL'])) { // IIS with Microsoft Rewrite Module
            $requestUri = $_SERVER['HTTP_X_ORIGINAL_URL'];
        } elseif (isset($_SERVER['HTTP_X_REWRITE_URL'])) { // check this first so IIS will catch
            $requestUri = $_SERVER['HTTP_X_REWRITE_URL'];
        } elseif (isset($_SERVER['REQUEST_URI'])) {
            $requestUri = $_SERVER['REQUEST_URI'];
        } elseif (isset($_SERVER['ORIG_PATH_INFO'])) { // IIS 5.0, PHP as CGI
            $requestUri = $_SERVER['ORIG_PATH_INFO'];
        } else {
            $requestUri = $_SERVER['SCRIPT_NAME'];
        }
        if( ($pos = strpos($requestUri, "?")) !== false) {
            $requestUri = substr($requestUri, 0, $pos);
        }

        return $requestUri;
    }

getSchema()

getSchema ( )

protected

Detect and returns the current HTTP/HTTPS Schema

Returns

string

Definition at line 240 of file AutoDiscover.php.

    {
        $schema = "http";
        if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
            $schema = 'https';
        }
        return $schema;
    }

getType()

getType

(

$type

)

Returns an XSD Type for the given PHP type

Parameters

string

$type

PHP Type to get the XSD type for

Returns

string

Todo:

Exception throwing may be more correct

Definition at line 600 of file AutoDiscover.php.

    {
        if (!($this->_wsdl instanceof Zend_Soap_Wsdl)) {
            // WSDL is not defined yet, so we can't recognize type in context of current service
            return '';
        } else {
            return $this->_wsdl->getType($type);
        }
    }

getUri()

getUri

(

)

Return the current Uri that the SOAP WSDL Service will be located at.

Returns

Zend_Uri

Definition at line 151 of file AutoDiscover.php.

    {
        if($this->_uri !== null) {
            $uri = $this->_uri;
        } else {
            $schema     = $this->getSchema();
            $host       = $this->getHostName();
            $scriptName = $this->getRequestUriWithoutParameters();
            $uri = Zend_Uri::factory($schema . '://' . $host . $scriptName);
            $this->setUri($uri);
        }
        return $uri;
    }

getWsdlClass()

getWsdlClass

(

)

Return the name of the WSDL handling class.

Returns

string

Definition at line 190 of file AutoDiscover.php.

    {
        return $this->_wsdlClass;
    }

handle()

handle

(

$request = false

)

Handle the Request

Parameters

string

$request

A non-standard request - Not Used

Implements Zend_Server_Interface.

Definition at line 513 of file AutoDiscover.php.

    {
        if (!headers_sent()) {
            header('Content-Type: text/xml');
        }
        $this->_wsdl->dump();
    }

loadFunctions()

loadFunctions

(

$definition

)

Load Functions

Parameters

unknown_type

$definition

Exceptions

Zend_Soap_AutoDiscover_Exception

Implements Zend_Server_Interface.

Definition at line 576 of file AutoDiscover.php.

    {
        #require_once "Zend/Soap/AutoDiscover/Exception.php";
        throw new Zend_Soap_AutoDiscover_Exception("Function has no use in AutoDiscover.");
    }

setBindingStyle()

setBindingStyle

(

array

$bindingStyle = array()

)

Set Binding soap:binding style.

By default 'style' is 'rpc' and 'transport' is 'http://schemas.xmlsoap.org/soap/http'.

Parameters

array

$bindingStyle

Returns

Zend_Soap_AutoDiscover

Definition at line 224 of file AutoDiscover.php.

    {
        if(isset($bindingStyle['style'])) {
            $this->_bindingStyle['style'] = $bindingStyle['style'];
        }
        if(isset($bindingStyle['transport'])) {
            $this->_bindingStyle['transport'] = $bindingStyle['transport'];
        }
        return $this;
    }

setClass()

setClass	(		$class,
			$namespace = '',
			$argv = null
	)

Set the Class the SOAP server will use

Parameters

string	$class	Class Name
string	$namespace	Class Namspace - Not Used
array	$argv	Arguments to instantiate the class - Not Used

Returns

Zend_Soap_AutoDiscover

Implements Zend_Server_Interface.

Definition at line 313 of file AutoDiscover.php.

    {
        $uri = $this->getUri();

        $wsdl = new $this->_wsdlClass($class, $uri, $this->_strategy);

        // The wsdl:types element must precede all other elements (WS-I Basic Profile 1.1 R2023)
        $wsdl->addSchemaTypeSection();

        $port = $wsdl->addPortType($class . 'Port');
        $binding = $wsdl->addBinding($class . 'Binding', 'tns:' .$class. 'Port');

        $wsdl->addSoapBinding($binding, $this->_bindingStyle['style'], $this->_bindingStyle['transport']);
        $wsdl->addService($class . 'Service', $class . 'Port', 'tns:' . $class . 'Binding', $uri);
        foreach ($this->_reflection->reflectClass($class)->getMethods() as $method) {
            $this->_addFunctionToWsdl($method, $wsdl, $port, $binding);
        }
        $this->_wsdl = $wsdl;

        return $this;
    }

setComplexTypeStrategy()

setComplexTypeStrategy

(

$strategy

)

Set the strategy that handles functions and classes that are added AFTER this call.

Parameters

boolean | string | Zend_Soap_Wsdl_Strategy_Interface

$strategy

Returns

Zend_Soap_AutoDiscover

Definition at line 295 of file AutoDiscover.php.

    {
        $this->_strategy = $strategy;
        if($this->_wsdl instanceof  Zend_Soap_Wsdl) {
            $this->_wsdl->setComplexTypeStrategy($strategy);
        }

        return $this;
    }

setOperationBodyStyle()

setOperationBodyStyle

(

array

$operationStyle = array()

)

Set options for all the binding operations soap:body elements.

By default the options are set to 'use' => 'encoded' and 'encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/".

See also

Zend_Soap_AutoDiscover_Exception

Parameters

array

$operationStyle

Returns

Zend_Soap_AutoDiscover

Exceptions

Zend_Soap_AutoDiscover_Exception

Definition at line 206 of file AutoDiscover.php.

    {
        if(!isset($operationStyle['use'])) {
            #require_once "Zend/Soap/AutoDiscover/Exception.php";
            throw new Zend_Soap_AutoDiscover_Exception("Key 'use' is required in Operation soap:body style.");
        }
        $this->_operationBodyStyle = $operationStyle;
        return $this;
    }

setPersistence()

setPersistence

(

$mode

)

Set Persistance

Parameters

int

$mode

Exceptions

Zend_Soap_AutoDiscover_Exception

Implements Zend_Server_Interface.

Definition at line 588 of file AutoDiscover.php.

    {
        #require_once "Zend/Soap/AutoDiscover/Exception.php";
        throw new Zend_Soap_AutoDiscover_Exception("Function has no use in AutoDiscover.");
    }

setUri()

setUri

(

$uri

)

Set the location at which the WSDL file will be availabe.

See also

Zend_Soap_Exception

Parameters

Zend_Uri | string

$uri

Returns

Zend_Soap_AutoDiscover

Exceptions

Zend_Soap_AutoDiscover_Exception

Definition at line 130 of file AutoDiscover.php.

    {
        if (!is_string($uri) && !($uri instanceof Zend_Uri)) {
            #require_once "Zend/Soap/AutoDiscover/Exception.php";
            throw new Zend_Soap_AutoDiscover_Exception("No uri given to Zend_Soap_AutoDiscover::setUri as string or Zend_Uri instance.");
        }
        $this->_uri = $uri;

        // change uri in WSDL file also if existant
        if ($this->_wsdl instanceof Zend_Soap_Wsdl) {
            $this->_wsdl->setUri($uri);
        }

        return $this;
    }

setWsdlClass()

setWsdlClass

(

$wsdlClass

)

Set the name of the WSDL handling class.

See also

Zend_Soap_Exception

Zend_Soap_Exception

Parameters

string

$wsdlClass

Returns

Zend_Soap_AutoDiscover

Exceptions

Zend_Soap_AutoDiscover_Exception

Definition at line 174 of file AutoDiscover.php.

    {
        if (!is_string($wsdlClass) && !is_subclass_of($wsdlClass, 'Zend_Soap_Wsdl')) {
            #require_once "Zend/Soap/AutoDiscover/Exception.php";
            throw new Zend_Soap_AutoDiscover_Exception("No Zend_Soap_Wsdl subclass given to Zend_Soap_AutoDiscover::setWsdlClass as string.");
        }
        $this->_wsdlClass = $wsdlClass;

        return $this;
    }

toXml()

toXml

(

)

Proxy to WSDL toXml() function

Returns

string

Exceptions

Zend_Soap_AutoDiscover_Exception

See also

Zend_Soap_AutoDiscover_Exception

Definition at line 547 of file AutoDiscover.php.

    {
        if($this->_wsdl !== null) {
            return $this->_wsdl->toXml();
        } else {
            #require_once "Zend/Soap/AutoDiscover/Exception.php";
            throw new Zend_Soap_AutoDiscover_Exception("Cannot return autodiscovered contents, WSDL file has not been generated yet.");
        }
    }

Field Documentation

$_bindingStyle

$_bindingStyle = array('style' => 'rpc', 'transport' => 'http://schemas.xmlsoap.org/soap/http')

protected

Definition at line 92 of file AutoDiscover.php.

$_functions

$_functions = array()

protected

Definition at line 66 of file AutoDiscover.php.

$_operationBodyStyle

$_operationBodyStyle = array('use' => 'encoded', 'encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/")

protected

Definition at line 85 of file AutoDiscover.php.

$_reflection

$_reflection = null

protected

Definition at line 61 of file AutoDiscover.php.

$_strategy

$_strategy

protected

Definition at line 71 of file AutoDiscover.php.

$_uri

$_uri

protected

Definition at line 78 of file AutoDiscover.php.

$_wsdl

$_wsdl = null

protected

Definition at line 56 of file AutoDiscover.php.

$_wsdlClass

$_wsdlClass = 'Zend_Soap_Wsdl'

protected

Definition at line 99 of file AutoDiscover.php.

---

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

• vendor/magento/zendframework1/library/Zend/Soap/AutoDiscover.php