ePages 6.17.12 - DE_EPAGES/Newsletter/API/Object/NewsletterRecipient.pm

Package DE_EPAGES::Newsletter::API::Object::NewsletterRecipient

object interface for NewsletterRecipient.

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

Functions

className
dbPackage
delete
id
insert
primaryKey
set

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

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

delete

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

Syntax
$NewsletterRecipient->delete;
Hook
OBJ_DeleteNewsletterRecipient
hook parameter keys :
  • Object - this object - object
  • NewsletterRecipientID - Recipient Identifiert - int

id

Returns the NewsletterRecipient id.

Syntax
$NewsletterRecipientID = $NewsletterRecipient->id;
Return
$NewsletterRecipientID (int)
Recipient Identifiert

insert

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

Syntax
$NewsletterRecipient = DE_EPAGES::Newsletter::API::Object::NewsletterRecipient->insert($hInfo);
Example
my $Class = LoadClassByAlias('NewsletterRecipient');
my $NewsletterRecipient = $Class->insertObject($hInfo);
Input
$hInfo (ref.hash)
attributes of new object
Return
$NewsletterRecipient (object)
new object
Hook
OBJ_InsertNewsletterRecipient
hook parameter keys :
  • Object - this object - object
  • NewsletterRecipientID - Recipient Identifiert - int

primaryKey

Returns the name of the primary key.

Syntax
$PrimaryKey = $NewsletterRecipient->primaryKey;
Return
$PrimaryKey (String)
primimary key

set

This function triggers hooks 'OBJ_BeforeUpdateNewsletterRecipient' and 'OBJ_AfterUpdateNewsletterRecipient'.

Syntax
$NewsletterRecipient->set($hValues, $LanguageID);
Input
$hValues (ref.hash)
attribute name => value hash
$LanguageID (int)
(optional; required for localized attributes) language id
Hook
OBJ_BeforeUpdateNewsletterRecipient
hook parameter keys :
  • Object - this object - object
  • NewsletterRecipientID - Recipient Identifiert - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateNewsletterRecipient
hook parameter keys :
  • Object - this object - object
  • NewsletterRecipientID - Recipient Identifiert - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int