Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Soap_AutoDiscover Class Reference

Public Member Functions

 __construct ($strategy=true, $uri=null, $wsdlClass=null)
 Constructor.
 
 setUri ($uri)
 Set the location at which the WSDL file will be availabe.
 
 getUri ()
 Return the current Uri that the SOAP WSDL Service will be located at.
 
 setWsdlClass ($wsdlClass)
 Set the name of the WSDL handling class.
 
 getWsdlClass ()
 Return the name of the WSDL handling class.
 
 setOperationBodyStyle (array $operationStyle=array())
 Set options for all the binding operations soap:body elements.
 
 setBindingStyle (array $bindingStyle=array())
 Set Binding soap:binding style.
 
 setComplexTypeStrategy ($strategy)
 Set the strategy that handles functions and classes that are added AFTER this call.
 
 setClass ($class, $namespace= '', $argv=null)
 Set the Class the SOAP server will use.
 
 addFunction ($function, $namespace= '')
 Add a Single or Multiple Functions to the WSDL.
 
 fault ($fault=null, $code=null)
 Action to take when an error occurs.
 
 handle ($request=false)
 Handle the Request.
 
 dump ($filename)
 Proxy to WSDL dump function.
 
 toXml ()
 Proxy to WSDL toXml() function.
 
 getFunctions ()
 Return an array of functions in the WSDL.
 
 loadFunctions ($definition)
 Load Functions.
 
 setPersistence ($mode)
 Set Persistance.
 
 getType ($type)
 Returns an XSD Type for the given PHP type.
 

Protected Member Functions

 getSchema ()
 Detect and returns the current HTTP/HTTPS Schema.
 
 getHostName ()
 Detect and return the current hostname.
 
 getRequestUriWithoutParameters ()
 Detect and return the current script name without parameters.
 
 _addFunctionToWsdl ($function, $wsdl, $port, $binding)
 Add a function to the WSDL document.
 

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'
 

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

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

Add a function to the WSDL document.

Parameters
Zend_Server_Reflection_Function_Abstract$functionfunction to add
Zend_Soap_Wsdl$wsdlWSDL document
object$portwsdl:portType
object$bindingwsdl:binding
Returns
void
addFunction (   $function,
  $namespace = '' 
)

Add a Single or Multiple Functions to the WSDL.

Parameters
string$functionFunction Name
string$namespaceFunction namespace - Not Used
Returns
Zend_Soap_AutoDiscover

Implements Zend_Server_Interface.

dump (   $filename)

Proxy to WSDL dump function.

Parameters
string$filename
Returns
boolean
Exceptions
Zend_Soap_AutoDiscover_Exception
See Also
Zend_Soap_AutoDiscover_Exception
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.

getFunctions ( )

Return an array of functions in the WSDL.

Returns
array

Implements Zend_Server_Interface.

getHostName ( )
protected

Detect and return the current hostname.

Returns
string
getRequestUriWithoutParameters ( )
protected

Detect and return the current script name without parameters.

Returns
string
getSchema ( )
protected

Detect and returns the current HTTP/HTTPS Schema.

Returns
string
getType (   $type)

Returns an XSD Type for the given PHP type.

Parameters
string$typePHP Type to get the XSD type for
Returns
string
Todo:
Exception throwing may be more correct
getUri ( )

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

Returns
Zend_Uri
getWsdlClass ( )

Return the name of the WSDL handling class.

Returns
string
handle (   $request = false)

Handle the Request.

Parameters
string$requestA non-standard request - Not Used

Implements Zend_Server_Interface.

loadFunctions (   $definition)

Load Functions.

Parameters
unknown_type$definition
Exceptions
Zend_Soap_AutoDiscover_Exception

Implements Zend_Server_Interface.

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
setClass (   $class,
  $namespace = '',
  $argv = null 
)

Set the Class the SOAP server will use.

Parameters
string$classClass Name
string$namespaceClass Namspace - Not Used
array$argvArguments to instantiate the class - Not Used
Returns
Zend_Soap_AutoDiscover

Implements Zend_Server_Interface.

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
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
setPersistence (   $mode)

Set Persistance.

Parameters
int$mode
Exceptions
Zend_Soap_AutoDiscover_Exception

Implements Zend_Server_Interface.

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
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
toXml ( )

Proxy to WSDL toXml() function.

Returns
string
Exceptions
Zend_Soap_AutoDiscover_Exception
See Also
Zend_Soap_AutoDiscover_Exception

Member Data Documentation

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