ePages 6.10 - DE_EPAGES/FactFinder/API/Object/FactFinderChannel.pm

Package DE_EPAGES::FactFinder::API::Object::FactFinderChannel

object interface for FactFinderChannel.

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

Functions

className
dbPackage
delete
importXML
set

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $FactFinderChannel->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $FactFinderChannel->dbPackage;
Return
$DbPackage (String)
database package name

delete

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

Syntax
$FactFinderChannel->delete;
Hook
OBJ_DeleteFactFinderChannel
hook parameter keys :
  • Object - this object - object
  • ChannelID - channel id - int

importXML

Maps LanguageCode to LanguageID

Syntax
$Object = DE_EPAGES::Object::API::Object::Object->importXML($Handler, $hElement, $Class, $hAttributes);
Input
$Handler (object)
xml import handler with support function addObject
$hElement (ref.hash)
XML element structure, see XML::SAX
$Class (object)
class object; the new object will be an instance of this class
$hAttributes (ref.hash)
attributes hash
Return
$Object (object)
the imported object

set

This function triggers hooks 'OBJ_BeforeUpdateFactFinderChannel' and 'OBJ_AfterUpdateFactFinderChannel'.

Syntax
$FactFinderChannel->set($hValues, $LanguageID);
Hook
OBJ_BeforeUpdateFactFinderChannel
hook parameter keys :
  • Object - this object - object
  • ChannelID - channel id - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateFactFinderChannel
hook parameter keys :
  • Object - this object - object
  • ChannelID - channel id - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int