Soap/Server.php

Show:

inherited

Classes
- \Zend_Soap_Server

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Soap
Subpackage: Server

\Zend_Soap_Server
jump to top

Package: Zend_Soap\Server

Zend_Soap_Server

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses
Version: $Id$

Properties

string $_actor

Actor URI

Details

Type: string

string $_class

Class registered with this server

Details

Type: string

array $_classArgs = array()

Arguments to pass to {@link $_class} constructor

Default valuearray()Details

Type: array

array $_classmap

Array of SOAP type => PHP class pairings for handling return/incoming values

Details

Type: array

string $_encoding

Encoding

Details

Type: string

array $_faultExceptions = array()

Registered fault exceptions

Default valuearray()Details

Type: array

int $_features

SOAP Server Features

Details

Type: int

array|int $_functions = array()

Functions registered with this server; may be either an array or the SOAP_FUNCTIONS_ALL constant

Default valuearray()Details

Type: array | int

$_object

Object registered with this server

Details

Type: n/a

int $_persistence

Persistence mode; should be one of the SOAP persistence constants

Details

Type: int

string $_request

Request XML

Details

Type: string

string $_response

Response XML

Details

Type: string

boolean $_returnResponse = false

Flag: whether or not {@link handle()} should return a response instead of automatically emitting it.

Default valuefalseDetails

Type: boolean

int $_soapVersion = SOAP_1_2

SOAP version to use; SOAP_1_2 by default, to allow processing of headers

Default valueSOAP_1_2Details

Type: int

string $_uri

URI namespace for SOAP server

Details

Type: string

string $_wsdl

URI or path to WSDL

Details

Type: string

mixed $_wsdlCache

WSDL Caching Options of SOAP Server

Details

Type: mixed

boolean $_wsiCompliant

WS-I compliant

Details

Type: boolean

Methods

__construct(string $wsdl = null, array $options = null) : void

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()}.

Parameters

Name	Type	Description
$wsdl	string
$options	array

_getSoap() : \SoapServer

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.

Returns

Type	Description
\SoapServer

_initializeSoapErrorContext() : boolean

Method initalizes the error context that the SOAPServer enviroment will run in.

Returns

Type	Description
boolean	display_errors original value

_setRequest(\DOMDocument | \DOMNode | \SimpleXMLElement | \stdClass | string $request) : \Zend_Soap_Server

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

Parameters

Name	Type	Description
$request	\DOMDocument \| \DOMNode \| \SimpleXMLElement \| \stdClass \| string

Returns

Type	Description
\Zend_Soap_Server

addFunction(array | string $function, string $namespace = '') : \Zend_Soap_Server

Attach a function as a server method

Parameters

Name	Type	Description
$function	array \| string	Function name, array of function names to attach, or SOAP_FUNCTIONS_ALL to attach all functions
$namespace	string	Ignored

Returns

Type	Description
\Zend_Soap_Server

Throws

Exception	Description
\Zend_Soap_Server_Exception	on invalid functions

deregisterFaultException(string $class) : boolean

Deregister a fault exception from the fault exception stack

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
boolean

fault(string | \Exception $fault = null, string $code = "Receiver") : \SoapFault

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()}.

Parameters

Name	Type	Description
$fault	string \| \Exception
$code	string	SOAP Fault Codes

Returns

Type	Description
\SoapFault

Details

Link: http://www.w3.org/TR/soap12-part1/#faultcodes

getActor() : string

Retrieve actor

Returns

Type	Description
string

getClassmap() : mixed

Retrieve classmap

Returns

Type	Description
mixed

getEncoding() : string

Get encoding

Returns

Type	Description
string

getFaultExceptions() : array

Return fault exceptions list

Returns

Type	Description
array

getFunctions() : array

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).

Returns

Type	Description
array

Details

Access: public

getLastRequest() : string

Retrieve request XML

Returns

Type	Description
string

getLastResponse() : string

Get response XML

Returns

Type	Description
string

getOptions() : array

Return array of options suitable for using with SoapServer constructor

Returns

Type	Description
array

getPersistence() : \Zend_Soap_Server

Get server persistence

Returns

Type	Description
\Zend_Soap_Server

getReturnResponse() : boolean

Retrieve return response flag

Returns

Type	Description
boolean

getSoapFeatures() : int

Return current SOAP Features options

Returns

Type	Description
int

getSoapVersion() : int

Get SOAP version

Returns

Type	Description
int

getUri() : string

Retrieve URI

Returns

Type	Description
string

getWsdl() : string

Retrieve wsdl

Returns

Type	Description
string

getWsdlCache() : void

Get current SOAP Wsdl Caching option

getWsiCompliant() : boolean

Gt WS-I compliant

Returns

Type	Description
boolean

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).

Parameters

Name	Type	Description
$request	\DOMDocument \| \DOMNode \| \SimpleXMLElement \| \stdClass \| string	Optional request

Returns

Type	Description
void \| string

handlePhpErrors(int $errno, string $errstr, string $errfile = null, int $errline = null, array $errcontext = null) : void

Throw PHP errors as SoapFaults

Parameters

Name	Type	Description
$errno	int
$errstr	string
$errfile	string
$errline	int
$errcontext	array

Throws

Exception	Description
\SoapFault

loadFunctions( $definition) : void

Unimplemented: Load server definition

Parameters

Name	Type	Description
$definition

Throws

Exception	Description
\Zend_Soap_Server_Exception	Unimplemented

registerFaultException(string | array $class) : \Zend_Soap_Server

Parameters

Name	Type	Description
$class	string \| array	Exception class or array of exception classes

Returns

Type	Description
\Zend_Soap_Server

setActor(string $actor) : \Zend_Soap_Server

Set actor

Actor is the actor URI for the server.

Parameters

Name	Type	Description
$actor	string

Returns

Type	Description
\Zend_Soap_Server

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

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.

Parameters

Name	Type	Description
$class	string	Class Name which executes SOAP Requests at endpoint.
$namespace
$argv

Returns

Type	Description
\Zend_Soap_Server

Throws

Exception	Description
\Zend_Soap_Server_Exception	if called more than once, or if class does not exist

setClassmap(array $classmap) : \Zend_Soap_Server

Set classmap

Parameters

Name	Type	Description
$classmap	array

Returns

Type	Description
\Zend_Soap_Server

Throws

Exception	Description
\Zend_Soap_Server_Exception	for any invalid class in the class map

setEncoding(string $encoding) : \Zend_Soap_Server

Set encoding

Parameters

Name	Type	Description
$encoding	string

Returns

Type	Description
\Zend_Soap_Server

Throws

Exception	Description
\Zend_Soap_Server_Exception	with invalid encoding argument

setObject(object $object) : \Zend_Soap_Server

Attach an object to a server

Accepts an instanciated object to use when handling requests.

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
\Zend_Soap_Server

setOptions(array | \Zend_Config $options) : \Zend_Soap_Server

Set Options

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

Parameters

Name	Type	Description
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Soap_Server

setPersistence(int $mode) : \Zend_Soap_Server

Set server persistence

Parameters

Name	Type	Description
$mode	int

Returns

Type	Description
\Zend_Soap_Server

setReturnResponse(boolean $flag) : \Zend_Soap_Server

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()}.

Parameters

Name	Type	Description
$flag	boolean

Returns

Type	Description
\Zend_Soap_Server

setSoapFeatures(string | int $feature) : \Zend_Soap_Server

Set the SOAP Feature options.

Parameters

Name	Type	Description
$feature	string \| int

Returns

Type	Description
\Zend_Soap_Server

setSoapVersion(int $version) : \Zend_Soap_Server

Set SOAP version

Parameters

Name	Type	Description
$version	int	One of the SOAP_1_1 or SOAP_1_2 constants

Returns

Type	Description
\Zend_Soap_Server

Throws

Exception	Description
\Zend_Soap_Server_Exception	with invalid soap version argument

setUri(string $uri) : \Zend_Soap_Server

Set URI

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

Parameters

Name	Type	Description
$uri	string

Returns

Type	Description
\Zend_Soap_Server

Throws

Exception	Description
\Zend_Soap_Server_Exception	with invalid uri argument

setWsdl(string $wsdl) : \Zend_Soap_Server

Set wsdl

Parameters

Name	Type	Description
$wsdl	string	URI or path to a WSDL

Returns

Type	Description
\Zend_Soap_Server

setWsdlCache( $options) : \Zend_Soap_Server

Set the SOAP Wsdl Caching Options

Parameters

Name	Type	Description
$options

Returns

Type	Description
\Zend_Soap_Server

setWsiCompliant(boolean $value) : \Zend_Soap_Server

Set WS-I compliant

Parameters

Name	Type	Description
$value	boolean

Returns

Type	Description
\Zend_Soap_Server

validateUrn(string $urn) : true

Check for valid URN

Parameters

Name	Type	Description
$urn	string

Returns

Type	Description
true

Throws

Exception	Description
\Zend_Soap_Server_Exception	on invalid URN

Soap/Server.php

\Zend_Soap_Serverjump to top

Properties

Methods

\Zend_Soap_Server
jump to top