PHP Class Prado\Web\Services\TSoapServer

TSoapServer is a wrapper of the PHP SoapServer class. It associates a SOAP provider class to the SoapServer object. It also manages the URI for the SOAP service and WSDL.
Since: 3.1
Author: Qiang Xue ([email protected])
Inheritance: extends Prado\TApplicationComponent
Datei anzeigen Open project: pradosoft/prado

Public Methods

Method Description
fault ( $title, $details = '', $code = 'SERVER', $actor = '', $name = '' ) Generate a SOAP fault message.
getActor ( ) : string
getClassMaps ( ) : string
getEncoding ( ) : string
getID ( ) : string
getProvider ( ) : string
getRequestedMethod ( ) : string Soap method guessed from the SOAP message received.
getSessionPersistent ( ) : boolean
getUri ( ) : string
getVersion ( ) : string
getWsdl ( ) : string Returns the WSDL content of the SOAP server.
getWsdlUri ( ) : string
run ( ) Handles the SOAP request.
setActor ( $value )
setClassMaps ( $classes ) : string
setEncoding ( $value )
setID ( $id )
setProvider ( $provider )
setSessionPersistent ( $value )
setUri ( $uri )
setVersion ( $value )
setWsdlUri ( $value )

Protected Methods

Method Description
createServer ( ) : SoapServer Creates the SoapServer instance.
getOptions ( ) : array
guessMethodCallRequested ( string $class ) Guess the SOAP method request from the actual SOAP message

Method Details

createServer() protected method

Creates the SoapServer instance.
protected createServer ( ) : SoapServer
return SoapServer

fault() public method

Generate a SOAP fault message.
public fault ( $title, $details = '', $code = 'SERVER', $actor = '', $name = '' )

getActor() public method

public getActor ( ) : string
return string actor of the SOAP service

getClassMaps() public method

public getClassMaps ( ) : string
return string comma delimit list of complex type classes.

getEncoding() public method

public getEncoding ( ) : string
return string encoding of the SOAP service

getID() public method

public getID ( ) : string
return string the ID of the SOAP server

getOptions() protected method

protected getOptions ( ) : array
return array options for creating SoapServer instance

getProvider() public method

public getProvider ( ) : string
return string the SOAP provider class (in namespace format)

getRequestedMethod() public method

Soap method guessed from the SOAP message received.
public getRequestedMethod ( ) : string
return string soap method request, null if not found.

getSessionPersistent() public method

public getSessionPersistent ( ) : boolean
return boolean whether the SOAP service is persistent within session. Defaults to false.

getUri() public method

public getUri ( ) : string
return string the URI for the SOAP service

getVersion() public method

public getVersion ( ) : string
return string SOAP version, defaults to empty (meaning not set).

getWsdl() public method

If {@link getWsdlUri WsdlUri} is set, its content will be returned. If not, the {@link setProvider Provider} class will be investigated and the WSDL will be automatically genearted.
public getWsdl ( ) : string
return string the WSDL content of the SOAP server

getWsdlUri() public method

public getWsdlUri ( ) : string
return string the URI for WSDL

guessMethodCallRequested() protected method

Guess the SOAP method request from the actual SOAP message
protected guessMethodCallRequested ( string $class )
$class string current handler class.

run() public method

Handles the SOAP request.
public run ( )

setActor() public method

public setActor ( $value )

setClassMaps() public method

public setClassMaps ( $classes ) : string
return string comma delimit list of class names

setEncoding() public method

public setEncoding ( $value )

setID() public method

public setID ( $id )

setProvider() public method

public setProvider ( $provider )

setSessionPersistent() public method

public setSessionPersistent ( $value )

setUri() public method

public setUri ( $uri )

setVersion() public method

public setVersion ( $value )

setWsdlUri() public method

public setWsdlUri ( $value )