PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TSoapServer

TSoapServer class.

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.

TComponent
Extended by TApplicationComponent
Extended by TSoapServer
Package: System\Web\Services
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.1
Located at Web/Services/TSoapService.php
Methods summary
public string
# getID( )

Returns

string
the ID of the SOAP server
public
# setID( string $id )

Parameters

$id
string
the ID of the SOAP server

Throws

TInvalidDataValueException
if the ID ends with '.wsdl'.
public
# run( )

Handles the SOAP request.

Handles the SOAP request.

public
# fault( string $title, mixed $details = '', string $code = 'SERVER', string $actor = '', string $name = '' )

Generate a SOAP fault message.

Generate a SOAP fault message.

Parameters

$title
string
message title
$details
mixed
message details
$code
string
message code, defalt is 'SERVER'.
$actor
string
actors
$name
string
message name
protected
# guessMethodCallRequested( string $class )

Guess the SOAP method request from the actual SOAP message

Guess the SOAP method request from the actual SOAP message

Parameters

$class
string
$class current handler class.
public string
# getRequestedMethod( )

Soap method guessed from the SOAP message received.

Soap method guessed from the SOAP message received.

Returns

string
soap method request, null if not found.
protected SoapServer
# createServer( )

Creates the SoapServer instance.

Creates the SoapServer instance.

Returns

SoapServer
protected array
# getOptions( )

Returns

array
options for creating SoapServer instance
public string
# getWsdl( )

Returns the WSDL content of the SOAP server. If getWsdlUri WsdlUri is set, its content will be returned. If not, the setProvider Provider class will be investigated and the WSDL will be automatically genearted.

Returns the WSDL content of the SOAP server. If getWsdlUri WsdlUri is set, its content will be returned. If not, the setProvider Provider class will be investigated and the WSDL will be automatically genearted.

Returns

string
the WSDL content of the SOAP server
public string
# getWsdlUri( )

Returns

string
the URI for WSDL
public
# setWsdlUri( string $value )

Parameters

$value
string
the URI for WSDL
public string
# getUri( )

Returns

string
the URI for the SOAP service
public
# setUri( string $uri )

Parameters

$uri
string
the URI for the SOAP service
public string
# getProvider( )

Returns

string
the SOAP provider class (in namespace format)
public
# setProvider( string $provider )

Parameters

$provider
string
the SOAP provider class (in namespace format)
public string
# getVersion( )

Returns

string
SOAP version, defaults to empty (meaning not set).
public
# setVersion( string $value )

Parameters

$value
string
SOAP version, either '1.1' or '1.2'

Throws

TInvalidDataValueException
if neither '1.1' nor '1.2'
public string
# getActor( )

Returns

string
actor of the SOAP service
public
# setActor( string $value )

Parameters

$value
string
actor of the SOAP service
public string
# getEncoding( )

Returns

string
encoding of the SOAP service
public
# setEncoding( string $value )

Parameters

$value
string
encoding of the SOAP service
public boolean
# getSessionPersistent( )

Returns

boolean
whether the SOAP service is persistent within session. Defaults to false.
public
# setSessionPersistent( boolean $value )

Parameters

$value
boolean
whether the SOAP service is persistent within session.
public string
# getClassMaps( )

Returns

string
comma delimit list of complex type classes.
public string
# setClassMaps( mixed $classes )

Returns

string
comma delimit list of class names
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants summary
string WSDL_CACHE_PREFIX 'wsdl.'
#
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO