ePages 6.10 - DE_EPAGES/Newsletter/API/Object/NewsletterCampaign.pm

Package DE_EPAGES::Newsletter::API::Object::NewsletterCampaign

object interface for NewsletterCampaign.

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

Functions

addCustomer
delete
deleteSelf
insert
set

addCustomer

This function adds a customer to a newsletter campaign.

Syntax
$NewsletterCampaign->addCustomer($Customer);
Input
$Customer (object)
customer object

delete

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

Syntax
$NewsletterCampaign->delete;
Hook
OBJ_DeleteNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int

deleteSelf

Deletes the object at database tables.

Syntax
$NewsletterCampaign->deleteSelf;

insert

Insert this info as object, afterwards the hook 'OBJ_InsertNewsletterCampaign' is triggered. Before insert this info the hook OBJ_BeforeInsertNewsletterCampaign is triggered.

Syntax
$NewsletterCampaign = DE_EPAGES::Newsletter::API::Object::NewsletterCampaign->insert($hInfo);
Example
my $Class = LoadClassByAlias('NewsletterCampaign');
my $NewsletterCampaign = $Class->insertObject($hInfo);
Input
$Package (string)
class package
$hInfo (ref.hash)
attributes of new object
Return
$NewsletterCampaign (object)
new object
Hook
OBJ_InsertNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int
OBJ_BeforeInsertNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int

set

This function triggers hooks 'OBJ_BeforeUpdateNewsletterCampaign' and 'OBJ_AfterUpdateNewsletterCampaign'.

Syntax
$NewsletterCampaign->set($hValues, $LanguageID);
Hook
OBJ_BeforeUpdateNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int