API Documentation

Zend/Soap/AutoDiscover.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Soap_AutoDiscover

Package: Zend\Soap\AutoDiscover

Zend_Soap_AutoDiscover

Implements
\Zend_Server_Interface
Category
Zend  

Properties

Propertyprotectedarray  $_bindingStyle= 'array('style' => 'rpc''

soap:operation style

Default valuearray('style' => 'rpc'Details
Type
array
Propertyprotectedarray  $_functions= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_operationBodyStyle= 'array('use' => 'encoded''

soap:body operation style options

Default valuearray('use' => 'encoded'Details
Type
array
Propertyprotected\Zend_Server_Reflection  $_reflection= 'null'

Default valuenullDetails
Type
\Zend_Server_Reflection
Propertyprotectedboolean  $_strategy= ''

Details
Type
boolean
Propertyprotected\WSDL  $_uri= ''

Url where the WSDL file will be available at.

Uri
Details
Type
\WSDL
Propertyprotected\Zend_Soap_Wsdl  $_wsdl= 'null'

Default valuenullDetails
Type
\Zend_Soap_Wsdl
Propertyprotectedstring  $_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
Name Type Description
$strategy boolean|string|\Zend_Soap_Wsdl_Strategy_Interface
$uri string|\Zend_Uri
$wsdlClass string
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
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

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

Add a Single or Multiple Functions to the WSDL

Parameters
Name Type Description
$function string

Function Name

$namespace string

Function namespace - Not Used

Returns
Type Description
\Zend_Soap_AutoDiscover
methodpublicdump( 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
methodpublicfault( string $fault = null, string|int $code = null ) : void

Action to take when an error occurs

Parameters
Name Type Description
$fault string
$code string|int
Throws
Exception Description
\Zend_Soap_AutoDiscover_Exception
methodpublicgetFunctions( ) : array

Return an array of functions in the WSDL

Returns
Type Description
array
methodprotectedgetHostName( ) : string

Detect and return the current hostname

Returns
Type Description
string
methodprotectedgetRequestUriWithoutParameters( ) : string

Detect and return the current script name without parameters

Returns
Type Description
string
methodprotectedgetSchema( ) : string

Detect and returns the current HTTP/HTTPS Schema

Returns
Type Description
string
methodpublicgetType( 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
methodpublicgetUri( ) : \Zend_Uri

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

Returns
Type Description
\Zend_Uri
methodpublicgetWsdlClass( ) : string

Return the name of the WSDL handling class.

Returns
Type Description
string
methodpublichandle( string $request = false ) : void

Handle the Request

Parameters
Name Type Description
$request string

A non-standard request - Not Used

methodpublicloadFunctions( \unknown_type $definition ) : void

Load Functions

Parameters
Name Type Description
$definition \unknown_type
Throws
Exception Description
\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
Name Type Description
$bindingStyle array
Returns
Type Description
\Zend_Soap_AutoDiscover
methodpublicsetClass( string $class, string $namespace = '', array $argv = null ) : \Zend_Soap_AutoDiscover

Set the Class the SOAP server will use

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
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
Name Type Description
$strategy boolean|string|\Zend_Soap_Wsdl_Strategy_Interface
Returns
Type Description
\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
Name Type Description
$operationStyle array
Returns
Type Description
\Zend_Soap_AutoDiscover
Throws
Exception Description
\Zend_Soap_AutoDiscover_Exception
Details
See
\Zend_Soap_AutoDiscover_Exception  
methodpublicsetPersistence( int $mode ) : void

Set Persistance

Parameters
Name Type Description
$mode int
Throws
Exception Description
\Zend_Soap_AutoDiscover_Exception
methodpublicsetUri( \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
\Zend_Soap_Exception  
methodpublicsetWsdlClass( 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
\Zend_Soap_Exception  
See
\Zend_Soap_Exception  
methodpublictoXml( ) : string

Proxy to WSDL toXml() function

Returns
Type Description
string
Throws
Exception Description
\Zend_Soap_AutoDiscover_Exception
Documentation was generated by DocBlox 0.15.1.