[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Soap/ -> Server.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
File Size: 959 lines (25 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Soap_Server:: (40 methods):
  __construct()
  setOptions()
  getOptions()
  setEncoding()
  getEncoding()
  setSoapVersion()
  getSoapVersion()
  validateUrn()
  setActor()
  getActor()
  setUri()
  getUri()
  setClassmap()
  getClassmap()
  setWsdl()
  getWsdl()
  setSoapFeatures()
  getSoapFeatures()
  setWsdlCache()
  getWsdlCache()
  addFunction()
  setClass()
  setObject()
  getFunctions()
  loadFunctions()
  setPersistence()
  getPersistence()
  _setRequest()
  getLastRequest()
  setReturnResponse()
  getReturnResponse()
  getLastResponse()
  _getSoap()
  handle()
  _initializeSoapErrorContext()
  registerFaultException()
  deregisterFaultException()
  getFaultExceptions()
  fault()
  handlePhpErrors()


Class: Zend_Soap_Server  - X-Ref

Zend_Soap_Server

__construct($wsdl = null, array $options = null)   X-Ref
Constructor

Sets display_errors INI setting to off (prevent client errors due to bad
XML in response). Registers {@link handlePhpErrors()} as error handler
for E_USER_ERROR.

If $wsdl is provided, it is passed on to {@link setWsdl()}; if any
options are specified, they are passed on to {@link setOptions()}.

param: string $wsdl
param: array $options
return: void

setOptions($options)   X-Ref
Set Options

Allows setting options as an associative array of option => value pairs.

param: array|Zend_Config $options
return: Zend_Soap_Server

getOptions()   X-Ref
Return array of options suitable for using with SoapServer constructor

return: array

setEncoding($encoding)   X-Ref
Set encoding

param: string $encoding
return: Zend_Soap_Server

getEncoding()   X-Ref
Get encoding

return: string

setSoapVersion($version)   X-Ref
Set SOAP version

param: int $version One of the SOAP_1_1 or SOAP_1_2 constants
return: Zend_Soap_Server

getSoapVersion()   X-Ref
Get SOAP version

return: int

validateUrn($urn)   X-Ref
Check for valid URN

param: string $urn
return: true

setActor($actor)   X-Ref
Set actor

Actor is the actor URI for the server.

param: string $actor
return: Zend_Soap_Server

getActor()   X-Ref
Retrieve actor

return: string

setUri($uri)   X-Ref
Set URI

URI in SoapServer is actually the target namespace, not a URI; $uri must begin with 'urn:'.

param: string $uri
return: Zend_Soap_Server

getUri()   X-Ref
Retrieve URI

return: string

setClassmap($classmap)   X-Ref
Set classmap

param: array $classmap
return: Zend_Soap_Server

getClassmap()   X-Ref
Retrieve classmap

return: mixed

setWsdl($wsdl)   X-Ref
Set wsdl

param: string $wsdl  URI or path to a WSDL
return: Zend_Soap_Server

getWsdl()   X-Ref
Retrieve wsdl

return: string

setSoapFeatures($feature)   X-Ref
Set the SOAP Feature options.

param: string|int $feature
return: Zend_Soap_Server

getSoapFeatures()   X-Ref
Return current SOAP Features options

return: int

setWsdlCache($options)   X-Ref
Set the SOAP Wsdl Caching Options

param: string|int|boolean $caching
return: Zend_Soap_Server

getWsdlCache()   X-Ref
Get current SOAP Wsdl Caching option


addFunction($function, $namespace = '')   X-Ref
Attach a function as a server method

param: array|string $function Function name, array of function names to attach,
param: string $namespace Ignored
return: Zend_Soap_Server

setClass($class, $namespace = '', $argv = null)   X-Ref
Attach a class to a server

Accepts a class name to use when handling requests. Any additional
arguments will be passed to that class' constructor when instantiated.

See {@link setObject()} to set preconfigured object instances as request handlers.

param: string $class Class Name which executes SOAP Requests at endpoint.
return: Zend_Soap_Server

setObject($object)   X-Ref
Attach an object to a server

Accepts an instanciated object to use when handling requests.

param: object $object
return: Zend_Soap_Server

getFunctions()   X-Ref
Return a server definition array

Returns a list of all functions registered with {@link addFunction()},
merged with all public methods of the class set with {@link setClass()}
(if any).

return: array

loadFunctions($definition)   X-Ref
Unimplemented: Load server definition

param: array $array
return: void

setPersistence($mode)   X-Ref
Set server persistence

param: int $mode
return: Zend_Soap_Server

getPersistence()   X-Ref
Get server persistence

return: Zend_Soap_Server

_setRequest($request)   X-Ref
Set request

$request may be any of:
- DOMDocument; if so, then cast to XML
- DOMNode; if so, then grab owner document and cast to XML
- SimpleXMLElement; if so, then cast to XML
- stdClass; if so, calls __toString() and verifies XML
- string; if so, verifies XML

param: DOMDocument|DOMNode|SimpleXMLElement|stdClass|string $request
return: Zend_Soap_Server

getLastRequest()   X-Ref
Retrieve request XML

return: string

setReturnResponse($flag)   X-Ref
Set return response flag

If true, {@link handle()} will return the response instead of
automatically sending it back to the requesting client.

The response is always available via {@link getResponse()}.

param: boolean $flag
return: Zend_Soap_Server

getReturnResponse()   X-Ref
Retrieve return response flag

return: boolean

getLastResponse()   X-Ref
Get response XML

return: string

_getSoap()   X-Ref
Get SoapServer object

Uses {@link $_wsdl} and return value of {@link getOptions()} to instantiate
SoapServer object, and then registers any functions or class with it, as
well as peristence.

return: SoapServer

handle($request = null)   X-Ref
Handle a request

Instantiates SoapServer object with options set in object, and
dispatches its handle() method.

$request may be any of:
- DOMDocument; if so, then cast to XML
- DOMNode; if so, then grab owner document and cast to XML
- SimpleXMLElement; if so, then cast to XML
- stdClass; if so, calls __toString() and verifies XML
- string; if so, verifies XML

If no request is passed, pulls request using php:://input (for
cross-platform compatability purposes).

param: DOMDocument|DOMNode|SimpleXMLElement|stdClass|string $request Optional request
return: void|string

_initializeSoapErrorContext()   X-Ref
Method initalizes the error context that the SOAPServer enviroment will run in.

return: boolean display_errors original value

registerFaultException($class)   X-Ref
Register a valid fault exception

param: string|array $class Exception class or array of exception classes
return: Zend_Soap_Server

deregisterFaultException($class)   X-Ref
Deregister a fault exception from the fault exception stack

param: string $class
return: boolean

getFaultExceptions()   X-Ref
Return fault exceptions list

return: array

fault($fault = null, $code = "Receiver")   X-Ref
Generate a server fault

Note that the arguments are reverse to those of SoapFault.

If an exception is passed as the first argument, its message and code
will be used to create the fault object if it has been registered via
{@Link registerFaultException()}.

param: string|Exception $fault
param: string $code SOAP Fault Codes
return: SoapFault

handlePhpErrors($errno, $errstr, $errfile = null, $errline = null, array $errcontext = null)   X-Ref
Throw PHP errors as SoapFaults

param: int $errno
param: string $errstr
param: string $errfile
param: int $errline
param: array $errcontext
return: void



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1