OpenPSA API Documentation
\
midcom
datamanager
extension
transformer
type
helper
indexer
storage
container
template
validation
dba
events
grid
provider
routing
workflow

\org_openpsa_directmarketing_cleanup

Direct Marketing cleanup system

Usable for systems where the history of subscriptions and receipts is not absolutely necessary. The cleanup script will remove all of the following:

  • org_openpsa_campaign_messagereceipt
  • org_openpsa_link_log
  • org_openpsa_campaign_member (where orgOpenpsaObtype is not org_openpsa_directmarketing_campaign_member_dba::TESTER)
  • org_openpsa_person (without account)

that have not been updated within the configured time (by default one month).

Summary

Methods
Properties
Constants
__construct()
__get()
__isset()
set_active_leaf()
add_stylesheet()
get_workflow()
count()
delete()
$_component
$_i18n
$_l10n
$_l10n_midcom
$_config
No constants found
No protected methods found
No protected properties found
N/A
get_deletion_timestamp()
add_time_filter()
get_message_receipt_qb()
get_link_log_qb()
get_campaign_member_qb()
get_person_qb()
delete_entries()
$_services
N/A

Properties

$_component

$_component : string

The name of the component, e.g. net.nehmer.static. Should be used whenever the component's name is required instead of hardcoding it.

Type

string

$_i18n

$_i18n : \midcom_services_i18n

A handle to the i18n service.

Type

\midcom_services_i18n

$_l10n

$_l10n : \midcom_services_i18n_l10n

The components' L10n string database.

Type

\midcom_services_i18n_l10n

$_l10n_midcom

$_l10n_midcom : \midcom_services_i18n_l10n

The global MidCOM string database.

Type

\midcom_services_i18n_l10n

$_config

$_config : \midcom_helper_configuration

The current configuration.

Type

\midcom_helper_configuration

$_services

$_services : array

Array that holds the already instantiated services

Type

array

Methods

__construct()

__construct()

Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.

__get()

__get(  $field)

Parameters

$field

__isset()

__isset(  $field)

Parameters

$field

set_active_leaf()

set_active_leaf(  $leaf_id)

Parameters

$leaf_id

add_stylesheet()

add_stylesheet(string  $url, string  $media = false)

Convenience shortcut for adding CSS files

Parameters

string $url

The stylesheet URL
string $media

The media type(s) for the stylesheet, if any

get_workflow()

get_workflow(string  $identifier, array  $options = array()) : \midcom\workflow\dialog

Parameters

string $identifier
array $options

Returns

\midcom\workflow\dialog

count()

count(  $kept = false)

Parameters

$kept

delete()

delete()

get_deletion_timestamp()

get_deletion_timestamp()

get_message_receipt_qb()

get_message_receipt_qb(  $kept = false)

Parameters

$kept

get_link_log_qb()

get_link_log_qb(  $kept = false)

Parameters

$kept

get_campaign_member_qb()

get_campaign_member_qb(  $kept = false)

Parameters

$kept

get_person_qb()

get_person_qb(  $kept = false)

Parameters

$kept