Soap/AutoDiscover.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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

>VPropertyprotectedarray $_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
>VPropertyprotectedarray $_functions = array()
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_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
>VPropertyprotected\Zend_Server_Reflection $_reflection = null
Default valuenullDetails
Type
\Zend_Server_Reflection
>VPropertyprotectedboolean $_strategy
Details
Type
boolean
>VPropertyprotected\WSDL $_uri
Url where the WSDL file will be available at.
Details
Type
\WSDL
>VPropertyprotected\Zend_Soap_Wsdl $_wsdl = null
Default valuenullDetails
Type
\Zend_Soap_Wsdl
>VPropertyprotectedstring $_wsdlClass = 'Zend_Soap_Wsdl'
Name of the class to handle the WSDL creation.
Default value'Zend_Soap_Wsdl'Details
Type
string

Methods

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

Constructor

Parameters
NameTypeDescription
$strategyboolean | string | \Zend_Soap_Wsdl_Strategy_Interface
$uristring | \Zend_Uri
$wsdlClassstring
methodprotected_addFunctionToWsdl(\Zend_Server_Reflection_Function_Abstract $function, \Zend_Soap_Wsdl $wsdl, object $port, object $binding) : void

Add a function to the WSDL document.

Parameters
NameTypeDescription
$function\Zend_Server_Reflection_Function_Abstract

function to add

$wsdl\Zend_Soap_Wsdl

WSDL document

$portobject

wsdl:portType

$bindingobject

wsdl:binding

methodpublicaddFunction(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
NameTypeDescription
$functionstring

Function Name

$namespacestring

Function namespace - Not Used

Returns
TypeDescription
\Zend_Soap_AutoDiscover
methodpublicdump(string $filename) : boolean

Proxy to WSDL dump function

Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
methodpublicfault(string $fault = null, string | int $code = null) : mixed

Action to take when an error occurs

Parameters
NameTypeDescription
$faultstring
$codestring | int
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
methodpublicgetFunctions() : 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
TypeDescription
array
methodprotectedgetHostName() : string

Detect and return the current hostname

Returns
TypeDescription
string
methodprotectedgetRequestUriWithoutParameters() : string

Detect and return the current script name without parameters

Returns
TypeDescription
string
methodprotectedgetSchema() : string

Detect and returns the current HTTP/HTTPS Schema

Returns
TypeDescription
string
methodpublicgetType(string $type) : string

Returns an XSD Type for the given PHP type

Parameters
NameTypeDescription
$typestring

PHP Type to get the XSD type for

Returns
TypeDescription
string
methodpublicgetUri() : \Zend_Uri

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

Returns
TypeDescription
\Zend_Uri
methodpublicgetWsdlClass() : string

Return the name of the WSDL handling class.

Returns
TypeDescription
string
methodpublichandle(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
NameTypeDescription
$requeststring

A non-standard request - Not Used

Returns
TypeDescription
mixed
methodpublicloadFunctions(\unknown_type $definition) : void

Load Functions

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

Parameters
NameTypeDescription
$definition\unknown_type
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
methodpublicsetBindingStyle(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
NameTypeDescription
$bindingStylearray
Returns
TypeDescription
\Zend_Soap_AutoDiscover
methodpublicsetClass(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
NameTypeDescription
$classstring

Class Name

$namespacestring

Class Namspace - Not Used

$argvarray

Arguments to instantiate the class - Not Used

Returns
TypeDescription
\Zend_Soap_AutoDiscover
methodpublicsetComplexTypeStrategy(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
NameTypeDescription
$strategyboolean | string | \Zend_Soap_Wsdl_Strategy_Interface
Returns
TypeDescription
\Zend_Soap_AutoDiscover
methodpublicsetOperationBodyStyle(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
NameTypeDescription
$operationStylearray
Returns
TypeDescription
\Zend_Soap_AutoDiscover
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
Details
See
\Zend_Soap_AutoDiscover_Exception  
methodpublicsetPersistence(int $mode) : void

Set Persistance

Parameters
NameTypeDescription
$modeint
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
methodpublicsetUri(\Zend_Uri | string $uri) : \Zend_Soap_AutoDiscover

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

Parameters
NameTypeDescription
$uri\Zend_Uri | string
Returns
TypeDescription
\Zend_Soap_AutoDiscover
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
Details
See
\Zend_Soap_Exception  
methodpublicsetWsdlClass(string $wsdlClass) : \Zend_Soap_AutoDiscover

Set the name of the WSDL handling class.

Parameters
NameTypeDescription
$wsdlClassstring
Returns
TypeDescription
\Zend_Soap_AutoDiscover
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
Details
See
\Zend_Soap_Exception  
See
\Zend_Soap_Exception  
methodpublictoXml() : string

Proxy to WSDL toXml() function

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Soap_AutoDiscover_Exception
Documentation was generated by phpDocumentor 2.0.0a12.