Class \Prado\Web\Services\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="Prado\Web\Services\TSoapService">
      <soap id="stockquote" provider="MyStockQuote" />
    </service>
  </services>

PHP configuration style:

 'services' => array(
   'soap' => array(
    'class' => 'Prado\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 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 element. For example, the "provider" attribute refers to the \Prado\Web\Services\TSoapServer::setProvider 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="Prado\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 .

Class hierarchy

\Prado\Web\Services\TSoapService

\Prado\TService implements IService

\Prado\TApplicationComponent

\Prado\TComponent

Author: Knut Urdalen <knut.urdalen@gmail.com>
Author: Qiang Xue <qiang.xue@gmail.com>
Author: Carl G. Mathisen <carlgmathisen@gmail.com>
Since: 3.1

Methods summary
`public`	`__construct() : mixed` Constructor. Sets default service ID to 'soap'.
`public`	`constructUrl(string $serverID[, array<string\|int, mixed> $getParams = null ][, bool $encodeAmpersand = true ][, bool $encodeGetItems = true ]) : string` Constructs a URL with specified page path and GET parameters.
`public`	`getConfigFile() : string`
`public`	`getIsWsdlRequest() : bool`
`public`	`getServerID() : string`
`public`	`init(TXmlElement $config) : mixed` Initializes this module. This method is required by the IModule interface.
`public`	`run() : mixed` 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.
`public`	`setConfigFile(string $value) : mixed`
`protected`	`createServer() : TSoapServer` Creates the requested SOAP server. The SOAP server is initialized with the property values specified in the configuration.
`protected`	`resolveRequest() : mixed` Resolves the request parameter. It identifies the server ID and whether the request is for WSDL.
`private`	`loadConfig(mixed $config) : mixed` Loads configuration from an XML element

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEnabled, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, run, setEnabled, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`DEFAULT_SOAP_SERVER`	`\Prado\Web\Services\TSoapServer::class`

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\Services\TSoapService

Class hierarchy