Soap/AutoDiscover.php

Show:

inherited

Classes
- \Zend_Soap_AutoDiscover

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Soap
Subpackage: AutoDiscover
Version: $Id: AutoDiscover.php 24842 2012-05-31 18:31:28Z rob $

\Zend_Soap_AutoDiscover
jump to top

Package: Zend\Soap\AutoDiscover

Zend_Soap_AutoDiscover

Implements: \Zend_Server_Interface
Category: Zend

Properties

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

soap:operation style

Default valuearray('style' => 'rpc', 'transport' => 'http://schemas.xmlsoap.org/soap/http')Details

Type: array

array $_functions = array()

Default valuearray()Details

Type: array

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

soap:body operation style options

Default valuearray('use' => 'encoded', 'encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/")Details

Type: array

\Zend_Server_Reflection $_reflection = null

Default valuenullDetails

Type: \Zend_Server_Reflection

boolean $_strategy =

Details

Type: boolean

\WSDL $_uri =

Url where the WSDL file will be available at.

Details

Type: \WSDL

\Zend_Soap_Wsdl $_wsdl = null

Default valuenullDetails

Type: \Zend_Soap_Wsdl

string $_wsdlClass = 'Zend_Soap_Wsdl'

Name of the class to handle the WSDL creation.

Default value'Zend_Soap_Wsdl'Details

Type: string

Methods

__construct(boolean | string | \Zend_Soap_Wsdl_Strategy_Interface $strategy = true, string | \Zend_Uri $uri = null, string $wsdlClass = null) : void

Constructor

Parameters

Name	Type	Description
$strategy	boolean \| string \| \Zend_Soap_Wsdl_Strategy_Interface
$uri	string \| \Zend_Uri
$wsdlClass	string

_addFunctionToWsdl(\Zend_Server_Reflection_Function_Abstract $function, \Zend_Soap_Wsdl $wsdl, object $port, object $binding) : void

Add a function to the WSDL document.

Parameters

Name	Type	Description
$function	\Zend_Server_Reflection_Function_Abstract	function to add
$wsdl	\Zend_Soap_Wsdl	WSDL document
$port	object	wsdl:portType
$binding	object	wsdl:binding

addFunction(string $function, string $namespace = '') : \Zend_Soap_AutoDiscover

Add a Single or Multiple Functions to the WSDL

Namespacing is primarily for xmlrpc, but may be used with other implementations to prevent naming collisions.

Parameters

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

Returns

Type	Description
\Zend_Soap_AutoDiscover

dump(string $filename) : boolean

Proxy to WSDL dump function

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

fault(string $fault = null, string | int $code = null) : mixed

Action to take when an error occurs

Parameters

Name	Type	Description
$fault	string
$code	string \| int

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

getFunctions() : array

Return an array of functions in the WSDL

Returns a server definition array as created using Zend_Server_Reflection. Can be used for server introspection, documentation, or persistence.

Returns

Type	Description
array

getHostName() : string

Detect and return the current hostname

Returns

Type	Description
string

getRequestUriWithoutParameters() : string

Detect and return the current script name without parameters

Returns

Type	Description
string

getSchema() : string

Detect and returns the current HTTP/HTTPS Schema

Returns

Type	Description
string

getType(string $type) : string

Returns an XSD Type for the given PHP type

Parameters

Name	Type	Description
$type	string	PHP Type to get the XSD type for

Returns

Type	Description
string

getUri() : \Zend_Uri

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

Returns

Type	Description
\Zend_Uri

getWsdlClass() : string

Return the name of the WSDL handling class.

Returns

Type	Description
string

handle(string $request = false) : mixed

Handle the Request

Requests may be passed in, or the server may automagically determine the request based on defaults. Dispatches server request to appropriate method and returns a response

Parameters

Name	Type	Description
$request	string	A non-standard request - Not Used

Returns

Type	Description
mixed

loadFunctions(\unknown_type $definition) : void

Load Functions

Used for persistence; loads a construct as returned by getFunctions().

Parameters

Name	Type	Description
$definition	\unknown_type

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

setBindingStyle(array $bindingStyle = array()) : \Zend_Soap_AutoDiscover

Set Binding soap:binding style.

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

Parameters

Name	Type	Description
$bindingStyle	array

Returns

Type	Description
\Zend_Soap_AutoDiscover

setClass(string $class, string $namespace = '', array $argv = null) : \Zend_Soap_AutoDiscover

Set the Class the SOAP server will use

The individual implementations should probably allow passing a variable number of arguments in, so that developers may define custom runtime arguments to pass to server methods.

Namespacing is primarily for xmlrpc, but could be used for other implementations as well.

Parameters

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

Returns

Type	Description
\Zend_Soap_AutoDiscover

setComplexTypeStrategy(boolean | string | \Zend_Soap_Wsdl_Strategy_Interface $strategy) : \Zend_Soap_AutoDiscover

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

Parameters

Name	Type	Description
$strategy	boolean \| string \| \Zend_Soap_Wsdl_Strategy_Interface

Returns

Type	Description
\Zend_Soap_AutoDiscover

setOperationBodyStyle(array $operationStyle = array()) : \Zend_Soap_AutoDiscover

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/".

Parameters

Name	Type	Description
$operationStyle	array

Returns

Type	Description
\Zend_Soap_AutoDiscover

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

Details

See: \global\Zend_Soap_AutoDiscover_Exception

setPersistence(int $mode) : void

Set Persistance

Parameters

Name	Type	Description
$mode	int

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

setUri(\Zend_Uri | string $uri) : \Zend_Soap_AutoDiscover

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

Parameters

Name	Type	Description
$uri	\Zend_Uri \| string

Returns

Type	Description
\Zend_Soap_AutoDiscover

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

Details

See: \global\Zend_Soap_Exception

setWsdlClass(string $wsdlClass) : \Zend_Soap_AutoDiscover

Set the name of the WSDL handling class.

Parameters

Name	Type	Description
$wsdlClass	string

Returns

Type	Description
\Zend_Soap_AutoDiscover

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

Details

See: \global\Zend_Soap_Exception
See: \global\Zend_Soap_Exception

toXml() : string

Proxy to WSDL toXml() function

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Soap_AutoDiscover_Exception

Soap/AutoDiscover.php

\Zend_Soap_AutoDiscoverjump to top

Properties

Methods

\Zend_Soap_AutoDiscover
jump to top