Class: SOAP_Server

Source Location: /SOAP-0.10.1/Server.php

Class Overview

PEAR
   |
   --SOAP_Base_Object
      |
      --SOAP_Base
         |
         --SOAP_Server

SOAP Server Class

Author(s):

Shane Caraveo <shane at php.net> Conversion to PEAR and updates
Dietrich Ayala <dietrich at ganx4.com> Original Author

Variables

Methods

Child classes:

SOAP_Server_Email: SOAP Server Class that implements an email SOAP server.

SOAP_Server_TCP: SOAP Server Class that implements a TCP SOAP Server.

Inherited Variables

Class: SOAP_Base_Object

SOAP_Base_Object::$fault
SOAP_Base_Object::$_debug_data

Inherited Methods

Class: SOAP_Base

SOAP_Base::SOAP_Base(): Constructor.
SOAP_Base::makeEnvelope(): Creates the SOAP envelope with the SOAP envelop data.
SOAP_Base::setDefaultNamespace(): Sets the default namespace.
SOAP_Base::setTypeTranslation(): Explicitly sets the translation for a specific class.
SOAP_Base::__set_type_translation()

Class: SOAP_Base_Object

SOAP_Base_Object::SOAP_Base_Object(): Constructor.

Class Details

[line 42]
SOAP Server Class

Originaly based on SOAPx4 by Dietrich Ayala http://dietrich.ganx4.com/soapx4

Author: Shane Caraveo <shane@php.net> Conversion to PEAR and updates
Author: Dietrich Ayala <dietrich@ganx4.com> Original Author
Access: public

[ Top ]

Class Variables

$callHandler = null

[line 52]

Type:

mixed

[ Top ]

$callValidation = true

[line 53]

Type:

mixed

[ Top ]

$call_methodname = null

[line 51]

Type:

mixed

[ Top ]

$dispatch_map = array()

[line 48]

Type:

array

[ Top ]

$dispatch_objects = array()

[line 49]

Type:

mixed

[ Top ]

$endpoint = ''

[line 77]

Type:

mixed

[ Top ]

$headers = array()

[line 60]

A list of headers that are going to be sent back to the client.

Type:

array

[ Top ]

$method_namespace = null

[line 80]

Type:

mixed

[ Top ]

$request = ''

[line 66]

Type:

string

[ Top ]

$response_encoding = 'UTF-8'

[line 73]

Type:

mixed

[ Top ]

$result = 'successful'

[line 75]

Type:

mixed

[ Top ]

$service = ''

[line 79]

Type:

mixed

[ Top ]

$soapobject = null

[line 50]

Type:

mixed

[ Top ]

$xml_encoding = SOAP_DEFAULT_ENCODING

[line 72]

Var: XML-Encoding

Type:

string

[ Top ]

Method Detail

SOAP_Server (Constructor) [line 93]

SOAP_Server SOAP_Server(
[
$options = null])

Parameters:

$options —

[ Top ]

addObjectMap [line 703]

void addObjectMap(

&$obj, [
$namespace = null], [
$service_name = 'Default'], [
$service_desc = ''])

Parameters:

	`&$obj`	—
	`$namespace`	—
	`$service_name`	—
	`$service_desc`	—

[ Top ]

addObjectWSDL [line 802]

void addObjectWSDL(

&$wsdl_obj, 
$targetNamespace, 
$service_name, [
$service_desc = ''])

Parameters:

	`&$wsdl_obj`	—
	`$targetNamespace`	—
	`$service_name`	—
	`$service_desc`	—

[ Top ]

addToMap [line 755]

void addToMap(

$methodname, 
$in, 
$out, [
$namespace = null], [
$alias = null])

Adds a method to the dispatch map.

Parameters:

	`$methodname`	—
	`$in`	—
	`$out`	—
	`$namespace`	—
	`$alias`	—

[ Top ]

bind [line 781]

void bind(

$wsdl_url)

Deprecated: use bindWSDL from now on

Parameters:

$wsdl_url —

[ Top ]

bindWSDL [line 790]

void bindWSDL(
string
$wsdl_url)

Parameters:

string $wsdl_url — a url to a WSDL resource

[ Top ]

buildResult [line 343]

array buildResult(

&$method_response, 
&$return_type, [string
$return_name = 'return'], [string
$namespace = ''], mixed
$method_response, array|string
$type)

Creates SOAP_Value objects with return values from method.

Uses method signature to determine type.

Return: List of SOAP_Value objects.

Parameters:

mixed	`$method_response`	—	The result(s).
array\|string	`$type`	—	The type(s) of the return value(s).
string	`$return_name`	—	The name of the return value.
string	`$namespace`	—	The namespace of the return value.
	`&$method_response`	—
	`&$return_type`	—

[ Top ]

callMethod [line 302]

void &callMethod(

$methodname, 
&$args)

Parameters:

	`$methodname`	—
	`&$args`	—

[ Top ]

parseRequest [line 379]

void parseRequest(
[
$data = ''], [
$attachments = null])

Parameters:

	`$data`	—
	`$attachments`	—

[ Top ]

service [line 167]

void service(
string
$data, [string
$endpoint = ''], [boolean
$test = false], [boolean
$return = false])

Parses the request and posts or returns the response.

Overridden in child classes as:

SOAP_Server_Email::service()

SOAP_Server_Email_Gateway::service()

SOAP_Server_TCP::service()

Parameters:

string	`$data`	—	The SOAP request data.
string	`$endpoint`	—	The service endpoint. Determined automatically if left empty.
boolean	`$test`	—
boolean	`$return`	—	Whether to return the SOAP response data instead of sending it to the client.

[ Top ]

setCallHandler [line 772]

void setCallHandler(

$callHandler, [
$validation = true])

Parameters:

	`$callHandler`	—
	`$validation`	—

[ Top ]

validateMethod [line 656]

void validateMethod(

$methodname, [
$namespace = null])

Parameters:

	`$methodname`	—
	`$namespace`	—

[ Top ]

verifyMethod [line 575]

void verifyMethod(

$request)

Parameters:

$request —

[ Top ]

__decodeRequest [line 515]

void &__decodeRequest(

$request, [
$shift = false])

Parameters:

	`$request`	—
	`$shift`	—

[ Top ]