final class \SmartModExtLib\Soap\SoapServerRequestHandler
{ } ::

Provides a SOAP Server Request Handler, full unicode compliant (UTF-8).
This class does NOT depend on the PHP SOAP extension

Language: PHP
Located at: modules/mod-soap/libs/SoapServerRequestHandler.php
Package: modules:Network
Namespace: \SmartModExtLib\Soap\
Class Name: SoapServerRequestHandler
Version: v.20210430
Depends: classes: Smart, SmartXmlParser, PHP DomXML extension (DOMDocument), SmartMarkersTemplating
Hints: Use this class to easy manage SOAP calls
Usage: static object: Class::method() - This class provides only STATIC methods

class Methods

public static function isSoapRequest ( ) {} :: BOOLEAN

@return: {BOOLEAN} TRUE if this is a SOAP Request or FALSE if not

Check if this is a SOAP Request

public static function getSoapRequestUrl ( ) {} :: STRING

@hints: This comes from SOAP Request, raw
@return: {STRING} if this is a SOAP Request will return a non-empty URL aka the HttpSoapAction ; else will return an empty URL

Get the SOAP URL from SOAP Request
The SOAP clients will have to send the HTTP_SOAPACTION to comply with this Server

public static function getSoapRequestAction ( ) {} :: STRING

@hints: This comes from SOAP Request, processed
@return: {STRING} if this is a SOAP Request have a non-empty URL aka the HttpSoapAction will return the #SoapAction ; else will return an empty string

Get the SOAP Action from SOAP Request
The Valid URL format to recognize the SOAP Action must be something like: urn://some-request.url/SomeSoapAction#SomeSoapAction
For using with Smart.Framework URL format can be: http(s)://smart-framework.url/?/page/some.controller/action/SomeSoapAction/#SomeSoapAction
If the SOAP Client is not able to handle the fragment (after the hashmark #), it can be used without it but in this case the soap action must be detected separately by parsing the getSoapRequestAction()

public static function getSoapRequestXmlStr ( ) {} :: STRING

@hints: This comes from SOAP Request, raw
@return: {STRING} Soap Request XML

Get the SOAP Request XML Str from SOAP Request

public static function getSoapRequestXmlArr ( ) {} :: ARRAY

@hints: This comes from SOAP Request, processed
@return: {ARRAY} Parsed SOAP Request XML as ARRAY

Get the SOAP Request XML Str parsed as Array from SOAP Request

public static function getSoapRequestXmlBodyArr ( ) {} :: ARRAY

@hints: This comes from SOAP Request, processed
@return: {ARRAY} Parsed SOAP Request XML[Body] as ARRAY

Get the SOAP Request XML Array re-parsed only for the Body section of the SOAP XML Request

public static function getSoapResponseXmlEnvelope ( STRING $url, STRING $xml, STRING $action = "" ) {} :: STRING

@hints: This have to be sent as returning response to the SOAP Client
@return: {STRING} The SOAP Envelope with the XML Response
@param: {STRING} $url: The current URL of the SOAP Server ; Ex: http(s)://smart-framework.url/?/page/some.controller/
@param: {STRING} $xml: The XML response that will be enveloped ; this will be done using CDATA to be more compliant
@param: {STRING} $action: The Response Action ; *OPTIONAL* ; Default is empty string ; If non-empty string it will use this, else will use the Action from SOAP Request

Get the SOAP Envelope XML Response to return to the SOAP Client

public static function getSoapResponseXmlError ( STRING $msg, STRING $code = "Server" ) {} :: STRING

@hints: This have to be sent as returning error response to the SOAP Client
@return: {STRING} The SOAP Error (Envelope) with the XML Error Response
@param: {STRING} $msg: The Error Message
@param: {STRING} $code: The Error Code ; *OPTIONAL* ; Default is: 'Server'

Get the SOAP Error XML Response to return to the SOAP Client

class Properties

class Constants

documentation generated on: 2023-10-19 23:15:58 +0000

final class \SmartModExtLib\Soap\SoapServerRequestHandler { } ::

class Methods

class Properties

class Constants

final class \SmartModExtLib\Soap\SoapServerRequestHandler
{ } ::