ePages 6.11.0 - DE_EPAGES/WebService/API/Object/WebService.pm

Package DE_EPAGES::WebService::API::Object::WebService

object interface for WebService.

Base
DE_EPAGES::Object::API::Object::Object

Functions

delete
deleteSelf
insert
method
set

delete

Deletes this object, therefore the hook 'OBJ_DeleteWebService' is triggered.

Syntax
$WebService->delete;
Hook
OBJ_DeleteWebService
hook parameter keys :
  • Object - this object - object
  • WebServiceID - web service id - int

deleteSelf

Deletes the object at database tables.

Syntax
$WebService->deleteSelf;

insert

Insert this info as object, afterwards the hook 'OBJ_InsertWebService' is triggered.

Syntax
$WebService = DE_EPAGES::WebService::API::Object::WebService->insert($hInfo);
Example
my $Class = LoadClassByAlias('WebService');
my $WebService = $Class->insertObject($hInfo);
Input
$Package (string)
class package
$hInfo (ref.hash)
attributes of new object
Return
$WebService (object)
new object
Hook
OBJ_InsertWebService
hook parameter keys :
  • Object - this object - object
  • WebServiceID - web service id - int

method

Returns a web service method by alias

Syntax
$Method = $WebService->method( $MethodAlias );
Example
method
Input
$MethodAlias (string)
methos alias
Return
$Method (object)
web service methos

set

This function triggers hooks 'OBJ_BeforeUpdateWebService' and 'OBJ_AfterUpdateWebService'.

Syntax
$WebService->set($hValues, $LanguageID);
Hook
OBJ_BeforeUpdateWebService
hook parameter keys :
  • Object - this object - object
  • WebServiceID - web service id - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateWebService
hook parameter keys :
  • Object - this object - object
  • WebServiceID - web service id - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int