BxDolService Class Reference

Inheritance diagram for BxDolService:

Static Public Member Functions
static	call ($mixed, $sMethod, $aParams=array(), $sClass='Module', $bIgnoreCache=false, $bIgnoreInactive=false)
static	callSerialized ($s, $aMarkers=array(), $sReplaceIn='params')
static	isSerializedService ($s)
static	getSerializedService ($mixedModule, $sMethod, $aParams=array(), $sClass='')

Detailed Description

Service calls to modules' methods.

The class has one static method to make service calls to the module's methods

Example of usage:

$isSpam = BxDolService::call('bx_antispam', 'is_spam', array($sText));

Memberships/ACL: Doesn't depend on user's membership.

Alerts: no alerts available

Member Function Documentation

call()

static BxDolService::call (   $mixed,   $sMethod,   $aParams = array(),   $sClass = 'Module',   $bIgnoreCache = false,   $bIgnoreInactive = false  )

static

Perform serice call

Parameters

$mixed	module name or module id
$sMethod	service method name in format 'method_name', corresponding class metod is serviceMethodName
$aParams	params to pass to service method
$sClass	class to search for service method, by default it is main module class

Returns

service call result

callSerialized()

static BxDolService::callSerialized (   $s,   $aMarkers = array(),   $sReplaceIn = 'params'  )

static

Perform serice call by accepting serialized array of service call parameters:

array (
    'module' => 'system', // module name
    'method' => 'test', // service method name
    'params' => array(), // array of parameters to pass to service method
    'class' => 'Module', // class to search service method in
)

Parameters

$s	serialized array of serice call
$aMarkers	service method name in format 'method_name', corresponding class metod is serviceMethodName
$sReplaceIn	params to pass to service method

Returns

service call result

getSerializedService()

static BxDolService::getSerializedService (   $mixedModule,   $sMethod,   $aParams = array(),   $sClass = ''  )

static

Serialized service call array

isSerializedService()

static BxDolService::isSerializedService (   $s )

static

Check if string is serialized array

---

The documentation for this class was generated from the following file:

• inc/classes/BxDolService.php