modules/Campaigns/utils.php

Show:

inherited

Table of Contents

Functions

campaign_log_lead_entry(
           $campaign_id,  $parent_bean,  $child_bean,  $activity_type
          )
        
        :
          void

This method is deprecated

Parameters

Name	Type	Description
$campaign_id
$parent_bean
$child_bean
$activity_type

Details

Deprecated: 62_Joneses - June 24, 2011
See: \campaign_log_lead_or_contact_entry()

campaign_log_lead_or_contact_entry(
           $campaign_id,  $parent_bean,  $child_bean,  $activity_type
          )
        
        :
          void

Parameters

Name	Type	Description
$campaign_id
$parent_bean
$child_bean
$activity_type

campaign_log_mail_merge(
          String $campaign_id, array $targets
          )
        
        :
          void

Handle campaign log entry creation for mail-merge activity. The function will be called by the soap component.

Parameters

Name	Type	Description
$campaign_id	String	campaign_id Primary key of the campaign
$targets	array	targets List of keys for entries from prospect_lists_prosects table

create_campaign_log_entry(
           $campaign_id,  $focus,  $rel_name,  $rel_bean,  $target_id
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$campaign_id
$focus
$rel_name
$rel_bean
$target_id

diagnose(
          
          )
        
        :
          void

getProspectListQSObjects(
           $source
              =
              '',  $return_field_name
              =
              'name',  $return_field_id
              =
              'id'
          )
        
        :
          void

Parameters

Name	Type	Description
$source
$return_field_name
$return_field_id

get_campaign_mailboxes(
          \unknown_type $emails,  $get_name
              =
              true
          )
        
        :
          \$get_name=true,

Return bounce handling mailboxes for campaign.

Parameters

Name	Type	Description
$emails	\unknown_type
$get_name

Returns

Type	Description
\$get_name=true,	bounce handling mailboxes' name; $get_name=false, bounce handling mailboxes' from name.

get_campaign_mailboxes_with_stored_options(
          
          )
        
        :
          void

get_campaign_urls(
           $campaign_id
          )
        
        :
          void

Parameters

Name	Type	Description
$campaign_id

get_message_scope_dom(
           $campaign_id,  $campaign_name,  $db
              =
              null,  $mod_strings
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$campaign_id
$campaign_name
$db
$mod_strings

get_subscription_lists(
           $focus,  $descriptions
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$focus
$descriptions

get_subscription_lists_keyed(
           $focus
          )
        
        :
          void

same function as get_subscription_lists, but with the data separated in an associated array

Parameters

Name	Type	Description
$focus

get_subscription_lists_query(
           $focus,  $additional_fields
              =
              null
          )
        
        :
          void

Queries for the list

Parameters

Name	Type	Description
$focus
$additional_fields

log_campaign_activity(
           $identifier,  $activity,  $update
              =
              true,  $clicked_url_key
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$identifier
$activity
$update
$clicked_url_key

process_subscriptions(
           $subscription_string_to_parse
          )
        
        :
          void

Parameters

Name	Type	Description
$subscription_string_to_parse

subscribe(
           $campaign,  $prospect_list,  $focus,  $default_list
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$campaign
$prospect_list
$focus
$default_list

track_campaign_prospects(
           $focus
          )
        
        :
          void

Parameters

Name	Type	Description
$focus

unsubscribe(
           $campaign,  $focus
          )
        
        :
          void

Parameters

Name	Type	Description
$campaign
$focus

write_mail_merge_log_entry(
          string $campaign_id, array $pl_row
          )
        
        :
          void

Function creates a campaign_log entry for campaigns processesed using the mail-merge feature. If any entry exist the hit counter is updated. target_tracker_key is used to locate duplicate entries.

Parameters

Name	Type	Description
$campaign_id	string	campaign_id Primary key of the campaign
$pl_row	array	A row of data from prospect_lists_prospects table.