SOAP
[ class tree: SOAP ] [ index: SOAP ] [ all elements ]

Class: SOAP_Server

Source Location: /SOAP-0.13.0/SOAP/Server.php

Class Overview

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

SOAP Server Class


Author(s):

Variables

Methods


Child classes:

SOAP_Server_TCP
SOAP Server Class that implements a TCP SOAP Server.
SOAP_Server_Email
SOAP Server Class that implements an email SOAP server.

Inherited Variables

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::SOAPENCPrefix()
Sets the SOAP-ENC prefix and returns the current value.
SOAP_Base::SOAPENVPrefix()
Sets the SOAP-ENV prefix and returns the current value.

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



[ 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 718]

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


Parameters:

   &$obj     
   $namespace     
   $service_name     
   $service_desc     

[ Top ]

addObjectWSDL   [line 817]

void addObjectWSDL( $wsdl_obj, $targetNamespace, $service_name, [ $service_desc = ''])


Parameters:

   $wsdl_obj     
   $targetNamespace     
   $service_name     
   $service_desc     

[ Top ]

addToMap   [line 770]

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 796]

void bind( $wsdl_url)

  • Deprecated: use bindWSDL from now on

Parameters:

   $wsdl_url     

[ Top ]

bindWSDL   [line 805]

void bindWSDL( string $wsdl_url)


Parameters:

string   $wsdl_url     a url to a WSDL resource

[ Top ]

buildResult   [line 347]

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 306]

void &callMethod( $methodname, &$args)


Parameters:

   $methodname     
   &$args     

[ Top ]

parseRequest   [line 383]

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_TCP::service()
SOAP_Server_Email::service()
SOAP_Server_Email_Gateway::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 787]

void setCallHandler( $callHandler, [ $validation = true])


Parameters:

   $callHandler     
   $validation     

[ Top ]

validateMethod   [line 671]

void validateMethod( $methodname, [ $namespace = null])


Parameters:

   $methodname     
   $namespace     

[ Top ]

verifyMethod   [line 585]

void verifyMethod( $request)


Parameters:

   $request     

[ Top ]

__decodeRequest   [line 525]

void &__decodeRequest( $request, [ $shift = false])


Parameters:

   $request     
   $shift     

[ Top ]


Documentation generated on Thu, 26 Jan 2012 14:00:13 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.