Class TSoapService
TSoapService class
TSoapService processes SOAP requests for a PRADO application. TSoapService requires PHP SOAP extension to be loaded.
TSoapService manages a set of SOAP providers. Each SOAP provider is a class that implements a set of SOAP methods which are exposed to SOAP clients for remote invocation. TSoapService generates WSDL automatically for the SOAP providers by default.
To use TSoapService, configure it in the application specification like following:
<services> <service id="soap" class="System.Web.Services.TSoapService"> <soap id="stockquote" provider="MyStockQuote" /> </service> </services>
PHP configuration style:
'services' => array( 'soap' => array( 'class' => 'System.Web.Services.TSoapService' 'properties' => array( 'provider' => 'MyStockQuote' ) ) )
The WSDL for the provider class "MyStockQuote" is generated based on special comment tags in the class. In particular, if a class method's comment contains the keyword "@soapmethod", it is considered to be a SOAP method and will be exposed to SOAP clients. For example,
class MyStockQuote { / ** * @param string $symbol the stock symbol * @return float the stock price * @soapmethod * / public function getQuote($symbol) {...} }
With the above SOAP provider, a typical SOAP client may call the method "getQuote" remotely like the following:
$client=new SoapClient("http://hostname/path/to/index.php?soap=stockquote.wsdl"); echo $client->getQuote("ibm");
Each <soap> element in the application specification actually
configures the properties of a SOAP server which defaults to TSoapServer
. Therefore, any writable property of TSoapServer
may appear
as an attribute in the <soap> element. For example, the "provider"
attribute refers to the TSoapServer::setProvider Provider property of
TSoapServer
. The following configuration specifies that the SOAP server
is persistent within the user session (that means a MyStockQuote object will be
stored in session)
<services> <service id="soap" class="System.Web.Services.TSoapService"> <soap id="stockquote" provider="MyStockQuote" SessionPersistent="true" /> </service> </services>
You may also use your own SOAP server class by specifying the "class" attribute of <soap>.
- TComponent
-
TApplicationComponent
-
TService implements IService
-
TSoapService
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Knut Urdalen <knut.urdalen@gmail.com>
Author: Qiang Xue <qiang.xue@gmail.com>
Author: Carl G. Mathisen <carlgmathisen@gmail.com>
Since: 3.1
Located at Web/Services/TSoapService.php
public
|
|
public
|
#
init(
Initializes this module. This method is required by the IModule interface. |
protected
|
#
resolveRequest( )
Resolves the request parameter. It identifies the server ID and whether the request is for WSDL. |
public
string
|
|
public
|
|
public
string
|
#
constructUrl( string $serverID, array $getParams = null, boolean $encodeAmpersand = true, boolean $encodeGetItems = true )
Constructs a URL with specified page path and GET parameters. |
public
boolean
|
|
public
string
|
|
protected
|
#
createServer( )
Creates the requested SOAP server. The SOAP server is initialized with the property values specified in the configuration. |
public
|
#
run( )
Runs the service. If the service parameter ends with '.wsdl', it will serve a WSDL file for the specified soap server. Otherwise, it will handle the soap request using the specified server. |
getEnabled(),
getID(),
setEnabled(),
setID()
|
getApplication(),
getRequest(),
getResponse(),
getService(),
getSession(),
getUser(),
publishAsset(),
publishFilePath()
|
string |
DEFAULT_SOAP_SERVER |
'TSoapServer' |
GLOBAL_RAISE_EVENT_LISTENER
|