Class: NS_SOAP_Service_Handler

Source Location: /handlers/NS_SOAP_Service_Handler.php

Class Overview

NS_Handler
   |
   --NS_Connection_Handler
      |
      --NS_HTTP_Service_Handler
         |
         --NS_SOAP_Service_Handler

SOAP 1.1 over HTTP Service handler class

Author(s):

Variables

Methods

Child classes:

NS_Direct_SOAP_Service_Handler: Direct SOAP over HTTP service handler class

NS_Persistent_SOAP_Service_Handler: Persistent SOAP over HTTP service handler class

Inherited Constants

Class: NS_HTTP_Service_Handler

NS_HTTP_Service_Handler::COMPRESS_AUTO
NS_HTTP_Service_Handler::COMPRESS_OFF
NS_HTTP_Service_Handler::DEFAULT_CONTENT_TYPE
NS_HTTP_Service_Handler::MAX_REQUEST_LENGTH
NS_HTTP_Service_Handler::SERVER_STRING

Class: NS_Connection_Handler

NS_Connection_Handler::FAIL_CONNREFUSED
NS_Connection_Handler::FAIL_CRYPTO
NS_Connection_Handler::FAIL_TIMEOUT

Inherited Variables

Class: NS_HTTP_Service_Handler

NS_HTTP_Service_Handler::$compress
NS_HTTP_Service_Handler::$compress_level
NS_HTTP_Service_Handler::$request_content
NS_HTTP_Service_Handler::$request_headers
NS_HTTP_Service_Handler::$request_method
NS_HTTP_Service_Handler::$request_protocol

Class: NS_Handler

NS_Handler::$socket

Inherited Methods

Class: NS_HTTP_Service_Handler

NS_HTTP_Service_Handler::__construct()
NS_HTTP_Service_Handler::Handle_Request()
NS_HTTP_Service_Handler::on_Read()

Class: NS_Connection_Handler

NS_Connection_Handler::Connect(): Connect
NS_Connection_Handler::Disconnect(): Disconnect
NS_Connection_Handler::on_Accept(): Event called on received connection
NS_Connection_Handler::on_Connect(): Event called on established connection
NS_Connection_Handler::on_Connect_Fail(): Event called on failed connection
NS_Connection_Handler::on_Disconnect(): Event called on disconnection
NS_Connection_Handler::on_Fork_Done(): Event called after forking, both on master and child processes
NS_Connection_Handler::on_Fork_Prepare(): Event called before forking
NS_Connection_Handler::on_Read(): Event called on data reception
NS_Connection_Handler::Write(): Send data over the connection
NS_Connection_Handler::Write_Stream(): Send open stream over the connection

Class: NS_Handler

NS_Handler::Set_Option(): Set a stream context option

Class Details

[line 39]
SOAP 1.1 over HTTP Service handler class

Tags:

abstract:
since:	1.0.2

[ Top ]

Class Variables

$exports =

[line 57]

List of exported methods with their parameters

Tags:

access:

protected

Type:

array

[ Top ]

$hostname =

[line 63]

Defines the host name of the server, useful for WSDL automatic generation

Tags:

access:

protected

Type:

string

[ Top ]

$method_name =

[line 51]

Last called method name

Tags:

access:

protected

Type:

string

[ Top ]

$request_url = ""

[line 45]

Request URL

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

constructor __construct [line 72]

NS_SOAP_Service_Handler __construct(
array
$options)

NS_SOAP_Service_Handler constructor

The constructor here only builds the exports list for WSDL automatic generation

Parameters:

array

$options

[ Top ]

method Fault [line 144]

string Fault(
string
$string, [string
$code = "Server"])

Returns a correctly formatted SOAP fault result

Tags:

access:

protected

Parameters:

string	$string
string	$code

[ Top ]

method Get_Base_Href [line 157]

string Get_Base_Href(
)

Returns a base location for the HTTP service based on the hostname option and the listening port

Tags:

access:

protected

[ Top ]

method Get_Exports [line 91]

array Get_Exports(
)

Get list of exported methods with their parameters

This methods needs to be overloaded and return the correct list in child classes

Tags:

abstract:
access:	public

Overridden in child classes as:

NS_Direct_SOAP_Service_Handler::Get_Exports()

NS_Persistent_SOAP_Service_Handler::Get_Exports()

[ Top ]

method Get_WSDL [line 200]

string Get_WSDL(
)

Generates a WSDL document for the current service

Tags:

access:

public

[ Top ]

method Get_XSD [line 273]

string Get_XSD(
string
$method)

Generates a XSD document for the specified method

Tags:

access:

public

Parameters:

string

$method

[ Top ]

method on_Call [line 471]

mixed on_Call(
string
$method, array
$args)

Event called on SOAP method call

the value returned by on_Call() will be sent back as the SOAP method call response

Tags:

abstract:
access:	public

Overridden in child classes as:

NS_Direct_SOAP_Service_Handler::on_Call()

NS_Persistent_SOAP_Service_Handler::on_Call()

Parameters:

string	$method
array	$args

[ Top ]

method on_Request [line 314]

void on_Request(

$url)

Tags:

access:

public

Parameters:

$url

[ Top ]

method SOAP_Add_Response_Envelope [line 129]

string SOAP_Add_Response_Envelope(
string
$result)

Add SOAP response envelope

Tags:

access:

protected

Parameters:

string

$result

[ Top ]

method Variable_To_SOAP_String [line 99]

string Variable_To_SOAP_String(
string
$var, [
$key = false])

Convert a PHP variable to SOAP string representation

Tags:

access:

protected

Parameters:

string	$var
	$key

[ Top ]

Documentation generated on Thu, 10 May 2012 22:01:24 +0200 by phpDocumentor 1.4.4