*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_BAO_BouncePattern extends CRM_Mailing_DAO_BouncePattern {
/**
- * Pseudo-constant pattern array
+ * Pseudo-constant pattern array.
*/
static $_patterns = NULL;
/**
* Build the static pattern array.
- *
- * @return void
*/
public static function buildPatterns() {
self::$_patterns = array();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_LocaationType
+ * @return CRM_Core_BAO_LocationType.
*/
public static function retrieve(&$params, &$defaults) {
$component = new CRM_Mailing_DAO_Component();
* (deprecated) the array that holds all the db ids.
*
* @return CRM_Mailing_BAO_Component
- *
*/
public static function add(&$params, $ids = array()) {
$id = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('id', $ids));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'Mail/mime.php';
/**
* An array that holds the complete templates
* including any headers or footers that need to be prepended
- * or appended to the body
+ * or appended to the body.
*/
private $preparedTemplates = NULL;
/**
* An array that holds the complete templates
* including any headers or footers that need to be prepended
- * or appended to the body
+ * or appended to the body.
*/
private $templates = NULL;
/**
- * An array that holds the tokens that are specifically found in our text and html bodies
+ * An array that holds the tokens that are specifically found in our text and html bodies.
*/
private $tokens = NULL;
/**
- * An array that holds the tokens that are specifically found in our text and html bodies
+ * An array that holds the tokens that are specifically found in our text and html bodies.
*/
private $flattenedTokens = NULL;
/**
- * The header associated with this mailing
+ * The header associated with this mailing.
*/
private $header = NULL;
/**
- * The footer associated with this mailing
+ * The footer associated with this mailing.
*/
private $footer = NULL;
/**
- * The HTML content of the message
+ * The HTML content of the message.
*/
private $html = NULL;
/**
- * The text content of the message
+ * The text content of the message.
*/
private $text = NULL;
/**
- * Cached BAO for the domain
+ * Cached BAO for the domain.
*/
private $_domain = NULL;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
*/
public static function getRecipientsCount($job_id, $mailing_id = NULL) {
// need this for backward compatibility, so we can get count for old mailings
- // please do not use this function if possible
+ // please do not use this function if possible.
$eq = self::getRecipients($job_id, $mailing_id);
return $eq->N;
}
/**
* note that $job_id is used only as a variable in the temp table construction
- * and does not play a role in the queries generated
+ * and does not play a role in the queries generated.
* @param int $job_id
* (misnomer) a nonce value used to name temporary tables.
* @param int $mailing_id
$order_by = "ORDER BY $email.is_bulkmail";
}
- /* Create a temp table for contact exclusion */
+ // Create a temp table for contact exclusion.
$mailingGroup->query(
"CREATE TEMPORARY TABLE X_$job_id
(contact_id int primary key)
ENGINE=HEAP"
);
- /* Add all the members of groups excluded from this mailing to the temp
- * table */
+ // Add all the members of groups excluded from this mailing to the temp
+ // table.
$excludeSubGroup = "INSERT INTO X_$job_id (contact_id)
SELECT DISTINCT $g2contact.contact_id
AND $mg.group_type = 'Exclude'";
$mailingGroup->query($excludeSubGroup);
- /* Add all unsubscribe members of base group from this mailing to the temp
- * table */
+ // Add all unsubscribe members of base group from this mailing to the temp
+ // table.
$unSubscribeBaseGroup = "INSERT INTO X_$job_id (contact_id)
SELECT DISTINCT $g2contact.contact_id
AND $mg.group_type = 'Base'";
$mailingGroup->query($unSubscribeBaseGroup);
- /* Add all the (intended) recipients of an excluded prior mailing to
- * the temp table */
+ // Add all the (intended) recipients of an excluded prior mailing to
+ // the temp table.
$excludeSubMailing = "INSERT IGNORE INTO X_$job_id (contact_id)
SELECT DISTINCT $eq.contact_id
$tempColumn = 'phone_id';
}
- /* Get all the group contacts we want to include */
+ // Get all the group contacts we want to include.
$mailingGroup->query(
"CREATE TEMPORARY TABLE I_$job_id
ENGINE=HEAP"
);
- /* Get the group contacts, but only those which are not in the
- * exclusion temp table */
+ // Get the group contacts, but only those which are not in the
+ // exclusion temp table.
$query = "REPLACE INTO I_$job_id (email_id, contact_id)
}
$mailingGroup->query($query);
- /* Query prior mailings */
+ // Query prior mailings.
$query = "REPLACE INTO I_$job_id (email_id, contact_id)
SELECT DISTINCT $email.id as email_id,
$mailingGroup->query($smartGroupInclude);
}
- /**
- * Construct the filtered search queries
- */
+ // Construct the filtered search queries.
$query = "
SELECT search_id, search_args, entity_id
FROM $mg
$mailingGroup->query($query);
}
- /* Get the emails with only location override */
+ // Get the emails with only location override.
$query = "REPLACE INTO I_$job_id (email_id, contact_id)
SELECT DISTINCT $email.id as local_email_id,
}
}
- /* Delete the temp table */
+ // Delete the temp table.
$mailingGroup->reset();
$mailingGroup->query("DROP TEMPORARY TABLE X_$job_id");
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @param int $id
* Id of the mail to delete.
- *
- * @return void
*/
public static function del($id) {
if (empty($id)) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'Mail.php';
*
* @param array $testParams
* @param null $mode
- *
- * @return void
*/
public static function runJobs($testParams = NULL, $mode = NULL) {
$job = new CRM_Mailing_BAO_MailingJob();
// Mark the child complete
if ($isComplete) {
- /* Finish the job */
+ // Finish the job.
$transaction = new CRM_Core_Transaction();
}
/**
- * post process to determine if the parent job.
- * as well as the mailing is complete after the run
+ * Post process to determine if the parent job
+ * as well as the mailing is complete after the run.
* @param null $mode
*/
public static function runJobs_post($mode = NULL) {
* A Mail object to send the messages.
*
* @param array $testParams
- *
- * @return void
*/
public function deliver(&$mailer, $testParams = NULL) {
$mailing = new CRM_Mailing_BAO_Mailing();
// CRM-12376
// This handles the edge case scenario where all the mails
- // have been delivered in prior jobs
+ // have been delivered in prior jobs.
$isDelivered = TRUE;
// make sure that there's no more than $mailerBatchLimit mails processed in a run
$params = $targetParams = $deliveredParams = array();
$count = 0;
- /**
- * CRM-15702: Sending bulk sms to contacts without e-mail address fails.
- * Solution is to skip checking for on hold
- */
- $skipOnHold = TRUE; //do include a statement to check wether e-mail address is on hold
+ // CRM-15702: Sending bulk sms to contacts without e-mail address fails.
+ // Solution is to skip checking for on hold
+ $skipOnHold = TRUE; //do include a statement to check wether e-mail address is on hold
if ($mailing->sms_provider_id) {
$skipOnHold = FALSE; //do not include a statement to check wether e-mail address is on hold
}
$details[0][$contactID] = array();
}
- /* Compose the mailing */
+ // Compose the mailing.
$recipient = $replyToEmail = NULL;
$replyValue = strcmp($mailing->replyto_email, $mailing->from_email);
if ($replyValue) {
continue;
}
- /* Send the mailing */
+ // Send the mailing.
$body = &$message->get();
$headers = &$message->headers();
CRM_Utils_System::civiExit();
}
- /* Register the bounce event */
+ // Register the bounce event.
$params = array(
'event_queue_id' => $field['id'],
CRM_Core_Error::debug_log_message($result->getMessage());
}
else {
- /* Register the delivery event */
+ // Register the delivery event.
$deliveredParams[] = $field['id'];
$targetParams[] = $field['contact_id'];
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_BAO_Query {
* If mailings are involved, add the specific Mailing fields
*
* @param $query
- *
- * @return void
*/
public static function select(&$query) {
// if Mailing mode add mailing id
*
*
* @param CRM_Core_Form $form
- * @return void
*/
public static function buildSearchForm(&$form) {
// mailing selectors
* @param $fieldTitle
*
* @param $valueTitles
- *
- * @return void
*/
public static function mailingEventQueryBuilder(&$query, &$values, $tableName, $fieldName, $fieldTitle, &$valueTitles) {
list($name, $op, $value, $grouping, $wildcard) = $values;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_BAO_Recipients extends CRM_Mailing_DAO_Recipients {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
}
$job = new CRM_Mailing_BAO_MailingJob();
- $job->is_test = 0; // if set to 1 it doesn't show in the UI
+ $job->is_test = 0; // if set to 1 it doesn't show in the UI
$job->status = 'Complete';
$job->scheduled_date = CRM_Utils_Date::processDate(date('Y-m-d'), date('H:i:s'));
$job->start_date = $job->scheduled_date;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Config {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Controller_Send extends CRM_Core_Controller {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'Mail/mime.php';
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered {
*
* @param array $params
* Associative array of delivery event values.
- *
- * @return void
*/
public static function &create(&$params) {
$q = &CRM_Mailing_Event_BAO_Queue::verify($params['job_id'],
}
/**
- * Since we never no when a mailing really bounces (hard bounce == NOW, soft bounce == NOW to NOW + 3 days?)
+ * Since we never know when a mailing really bounces (hard bounce == NOW, soft bounce == NOW to NOW + 3 days?)
* we cannot decide when an email address last got an email.
*
* We want to avoid putting on hold an email address which had a few bounces (mbox full) and then got quite a few
* Consider mailings that were completed at least $minDays ago.
* @param int $maxDays
* Consider mailings that were completed not more than $maxDays ago.
- *
- * @return void
*/
public static function updateEmailResetDate($minDays = 3, $maxDays = 7) {
$dao = new CRM_Core_Dao();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward {
return $successfulForward;
}
- /* Find the email address/contact, if it exists */
+ // Find the email address/contact, if it exists.
$contact = CRM_Contact_BAO_Contact::getTableName();
$location = CRM_Core_BAO_Location::getTableName();
if (isset($dao->queue_id) ||
(isset($dao->do_not_email) && $dao->do_not_email == 1)
) {
- /* We already sent this mailing to $forward_email, or we should
- * never email this contact. Give up. */
+ // We already sent this mailing to $forward_email, or we should
+ // never email this contact. Give up.
return $successfulForward;
}
$count = $contactValues['count'];
if ($count == 0) {
- /* If the contact does not exist, create one. */
+ // If the contact does not exist, create one.
$formatted = array(
'contact_type' => 'Individual',
$contact_id = $email->contact_id;
}
- /* Create a new queue event */
+ // Create a new queue event.
$queue_params = array(
'email_id' => $email_id,
'hash' => $queue->hash,
);
if (is_a($result, 'PEAR_Error')) {
- /* Register the bounce event */
+ // Register the bounce event.
$params = array_merge($params,
CRM_Mailing_BAO_BouncePattern::match($result->getMessage())
}
else {
$successfulForward = TRUE;
- /* Register the delivery event */
+ // Register the delivery event.
CRM_Mailing_Event_BAO_Delivered::create($params);
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened {
*
* @param int $queue_id
* The Queue Event ID of the recipient.
- *
- * @return void
*/
public static function open($queue_id) {
- /* First make sure there's a matching queue event */
+ // First make sure there's a matching queue event.
$success = FALSE;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'Mail/mime.php';
* The mailing object, or null on failure
*/
public static function &reply($job_id, $queue_id, $hash, $replyto = NULL) {
- /* First make sure there's a matching queue event */
+ // First make sure there's a matching queue event.
$q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
* HTML part of the body (ignored if $fullEmail provided).
* @param string $fullEmail
* Whole email to forward in one string.
- *
- * @return void
*/
public static function send($queue_id, &$mailing, &$bodyTxt, $replyto, &$bodyHTML = NULL, &$fullEmail = NULL) {
$domain = CRM_Core_BAO_Domain::getDomain();
* The queue ID.
* @param string $replyto
* Optional reply-to from the reply.
- *
- * @return void
*/
private static function autoRespond(&$mailing, $queue_id, $replyto) {
$config = CRM_Core_Config::singleton();
'Return-Path' => "do-not-reply@$emailDomain",
);
- /* TODO: do we need reply tokens? */
+ // TODO: do we need reply tokens?
$html = $component->body_html;
if ($component->body_text) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'Mail/mime.php';
* $groups Array of all groups to which the contact was added, or null if the queue event could not be found.
*/
public static function &resub_to_mailing($job_id, $queue_id, $hash) {
- /* First make sure there's a matching queue event */
+ // First make sure there's a matching queue event.
$q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
$success = NULL;
$group = CRM_Contact_BAO_Group::getTableName();
$gc = CRM_Contact_BAO_GroupContact::getTableName();
- //We Need the mailing Id for the hook...
+ // We Need the mailing Id for the hook...
$do->query("SELECT $job.mailing_id as mailing_id
FROM $job
WHERE $job.id = " . CRM_Utils_Type::escape($job_id, 'Integer'));
AND $group.is_hidden = 0"
);
- /* Make a list of groups and a list of prior mailings that received
- * this mailing */
-
+ // Make a list of groups and a list of prior mailings that received
+ // this mailing.
$groups = array();
$mailings = array();
}
}
- /* As long as we have prior mailings, find their groups and add to the
- * list */
-
+ // As long as we have prior mailings, find their groups and add to the
+ // list.
while (!empty($mailings)) {
$do->query("
SELECT $mg.entity_table as entity_table,
$base_groups = NULL;
CRM_Utils_Hook::unsubscribeGroups('resubscribe', $mailing_id, $contact_id, $group_ids, $base_groups);
- /* Now we have a complete list of recipient groups. Filter out all
- * those except smart groups and those that the contact belongs to */
-
+ // Now we have a complete list of recipient groups. Filter out all
+ // those except smart groups and those that the contact belongs to.
$do->query("
SELECT $group.id as group_id,
$group.title as title
* Is this domain-level?.
* @param int $job
* The job ID.
- *
- * @return void
*/
public static function send_resub_response($queue_id, $groups, $is_domain = FALSE, $job) {
// param is_domain is not supported as of now.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
$contact_id = $contactId;
}
else {
- /* First, find out if the contact already exists */
+ // First, find out if the contact already exists.
$query = "
SELECT DISTINCT contact_a.id as contact_id
if (!$contact_id) {
require_once 'CRM/Utils/DeprecatedUtils.php';
- /* If the contact does not exist, create one. */
+ // If the contact does not exist, create one.
$formatted = array(
'contact_type' => 'Individual',
return $success;
}
- /* Get the primary email id from the contact to use as a hash input */
+ // Get the primary email id from the contact to use as a hash input.
$dao = new CRM_Core_DAO();
*
* @param string $email
* The email address.
- *
- * @return void
*/
public function send_confirm_request($email) {
$config = CRM_Core_Config::singleton();
* Specifically to avoid linking group to wrong duplicate contact
* during event registration.
* @param string $context
- *
- * @return void
*/
public static function commonSubscribe(&$groups, &$params, $contactId = NULL, $context = NULL) {
$contactGroups = CRM_Mailing_Event_BAO_Subscribe::getContactGroups($params['email'], $contactId);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_TrackableURLOpen {
$search = new CRM_Mailing_BAO_TrackableURL();
- /* To find the url, we also join on the queue and job tables. This
- * prevents foreign key violations. */
+ // To find the url, we also join on the queue and job tables. This
+ // prevents foreign key violations.
$job = CRM_Mailing_BAO_MailingJob::getTableName();
$eq = CRM_Mailing_Event_BAO_Queue::getTableName();
);
if (!$search->fetch()) {
- /* Whoops, error, don't track it. Return the base url. */
+ // Whoops, error, don't track it. Return the base url.
return CRM_Utils_System::baseURL();
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'Mail/mime.php';
* $groups Array of all groups from which the contact was removed, or null if the queue event could not be found.
*/
public static function &unsub_from_mailing($job_id, $queue_id, $hash, $return = FALSE) {
- /* First make sure there's a matching queue event */
+ // First make sure there's a matching queue event.
$q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
$success = NULL;
AND $group.is_hidden = 0"
);
- /* Make a list of groups and a list of prior mailings that received
- * this mailing */
+ // Make a list of groups and a list of prior mailings that received
+ // this mailing.
$groups = array();
$base_groups = array();
}
}
- /* As long as we have prior mailings, find their groups and add to the
- * list */
+ // As long as we have prior mailings, find their groups and add to the
+ // list.
while (!empty($mailings)) {
$do->query("
$base_group_ids = array_keys($base_groups);
CRM_Utils_Hook::unsubscribeGroups('unsubscribe', $mailing_id, $contact_id, $group_ids, $base_group_ids);
- /* Now we have a complete list of recipient groups. Filter out all
- * those except smart groups, those that the contact belongs to and
- * base groups from search based mailings */
+ // Now we have a complete list of recipient groups. Filter out all
+ // those except smart groups, those that the contact belongs to and
+ // base groups from search based mailings.
$baseGroupClause = '';
if (!empty($base_group_ids)) {
* Is this domain-level?.
* @param int $job
* The job ID.
- *
- * @return void
*/
public static function send_unsub_response($queue_id, $groups, $is_domain = FALSE, $job) {
$config = CRM_Core_Config::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *
*/
class CRM_Mailing_Form_Approve extends CRM_Core_Form {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
if (CRM_Mailing_Info::workflowEnabled()) {
/**
* Set default values for the form.
- *
- *
- * @return void
*/
public function setDefaultValues() {
$defaults = array();
}
/**
- * Build the form object for the approval/rejection mailing
- *
- * @param
- *
- * @return void
+ * Build the form object for the approval/rejection mailing.
*/
public function buildQuickform() {
$title = ts('Approve/Reject Mailing') . " - {$this->_mailing->name}";
/**
* Process the posted form values. Approve /reject a mailing.
- *
- * @param
- *
- * @return void
*/
public function postProcess() {
// get the submitted form values.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* Build the form object for disable mail feature
- *
- * @param
- *
- * @return void
*/
class CRM_Mailing_Form_Browse extends CRM_Core_Form {
/**
* Heart of the viewing process. The runner gets all the meta data for
* the contact and calls the appropriate type of page to view.
- *
- * @return void
*/
public function preProcess() {
$this->_mailingId = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addButtons(array(
);
}
- /**
- *
- * @return void
- */
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
CRM_Mailing_BAO_Mailing::del($this->_mailingId);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Location Type
- *
+ * This class generates form components for Location Type.
*/
class CRM_Mailing_Form_Component extends CRM_Core_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->applyFilter('__ALL__', 'trim');
/**
* Set default values for the form.
- *
- *
- * @return void
*/
public function setDefaultValues() {
$defaults = array();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
// store the submitted values in an array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Form_ForwardMailing extends CRM_Core_Form {
public function preProcess() {
if ($q == NULL) {
- /** ERROR **/
+ // ERROR.
CRM_Core_Error::fatal(ts('Invalid form parameters.'));
CRM_Core_Error::statusBounce(ts('Invalid form parameters.'));
}
$this->assign('fromEmail', $fromEmail);
}
- /* Show the subject instead of the name here, since it's being
- * displayed to external contacts/users */
+ // Show the subject instead of the name here, since it's being
+ // displayed to external contacts/users.
CRM_Utils_System::setTitle(ts('Forward Mailing: %1', array(1 => $mailing->subject)));
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
for ($i = 0; $i < 5; $i++) {
/**
* Form submission of new/edit contact is processed.
- *
- *
- * @return void
*/
public function postProcess() {
$queue_id = $this->get('queue_id');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Form_Optout extends CRM_Core_Form {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Form_Search extends CRM_Core_Form {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Form_Subscribe extends CRM_Core_Form {
protected $_groupID = NULL;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
// add the email address
$addCaptcha = FALSE;
}
else {
- // if this is POST request and came from a block,
- // lets add recaptcha only if already present
- // gross hack for now
+ // If this is POST request and came from a block,
+ // lets add recaptcha only if already present.
+ // Gross hack for now.
if (!empty($_POST) &&
!array_key_exists('recaptcha_challenge_field', $_POST)
) {
return array('_qf_default' => 'Please select one or more mailing lists.');
}
- /**
- *
- * @return void
- */
public function postProcess() {
$params = $this->controller->exportValues($this->_name);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class generates form components for relationship
- *
*/
class CRM_Mailing_Form_Task extends CRM_Core_Form {
/**
* Build all the data structures needed to build the form.
- *
- * @param
- *
- * @return void
*/
public function preProcess() {
self::preProcessCommon($this);
$form->_componentClause = ' civicrm_mailing_recipients.id IN ( ' . implode(',', $ids) . ' ) ';
}
- //set the context for redirection for any task actions
+ // set the context for redirection for any task actions
$session = CRM_Core_Session::singleton();
$fragment = 'search';
* @param string $nextType
* @param string $backType
* @param bool $submitOnce
- *
- *
- * @return void
*/
public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
$this->addButtons(array(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
parent::preprocess();
/**
* Build the form object - it consists of
* - displaying the QILL (query in local language)
- * - displaying elements for saving the search
- *
- *
- * @return void
+ * - displaying elements for saving the search.
*/
public function buildQuickForm() {
//
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
// redirect to the main search page after printing is over
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Form_Unsubscribe extends CRM_Core_Form {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Info extends CRM_Core_Component_Info {
}
/**
- * Get AngularJS modules and their dependencies
+ * Get AngularJS modules and their dependencies.
*
* @return array
* list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
$session = CRM_Core_Session::singleton();
$contactID = $session->get('userID');
- // Get past mailings
- // CRM-16155 - Limit to a reasonable number
+ // Get past mailings.
+ // CRM-16155 - Limit to a reasonable number.
$civiMails = civicrm_api3('Mailing', 'get', array(
'is_completed' => 1,
'mailing_type' => array('IN' => array('standalone', 'winner')),
'sort' => 'is_archived asc, scheduled_date desc',
),
));
- // Generic params
+ // Generic params.
$params = array(
'options' => array('limit' => 0),
'sequential' => 1,
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_MailStore {
// flag to decide whether to print debug messages
var $_debug = FALSE;
/**
- * Return the proper mail store implementation, based on config settings
+ * Return the proper mail store implementation, based on config settings.
*
* @param string $name
* Name of the settings set from civimail_mail_settings to use (null for default).
}
/**
- * Expunge the messages marked for deletion; stub function to be redefined by IMAP store
+ * Expunge the messages marked for deletion; stub function to be redefined by IMAP store.
*/
public function expunge() {
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'ezc/Base/src/ezc_bootstrap.php';
*
* @param int $nr
* Number of the message to move.
- *
- * @return void
*/
public function markIgnored($nr) {
if ($this->_debug) {
*
* @param int $nr
* Number of the message to move.
- *
- * @return void
*/
public function markProcessed($nr) {
if ($this->_debug) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'ezc/Base/src/ezc_bootstrap.php';
$set = new ezcMailFileSet(array($file));
$parser = new ezcMailParser();
- //set property text attachment as file CRM-5408
+ // set property text attachment as file CRM-5408
$parser->options->parseTextAttachmentsAsFiles = TRUE;
$mail = $parser->parseMail($set);
* File location of the message to fetch.
*
* @throws Exception
- * @return void
*/
public function markIgnored($file) {
if ($this->_debug) {
* File location of the message to fetch.
*
* @throws Exception
- * @return void
*/
public function markProcessed($file) {
if ($this->_debug) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'ezc/Base/src/ezc_bootstrap.php';
public function fetchNext($count = 0) {
$mails = array();
$parser = new ezcMailParser();
- //set property text attachment as file CRM-5408
+ // set property text attachment as file CRM-5408
$parser->options->parseTextAttachmentsAsFiles = TRUE;
foreach (array(
* File location of the message to fetch.
*
* @throws Exception
- * @return void
*/
public function markIgnored($file) {
if ($this->_debug) {
* File location of the message to fetch.
*
* @throws Exception
- * @return void
*/
public function markProcessed($file) {
if ($this->_debug) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'ezc/Base/src/ezc_bootstrap.php';
}
/**
- * Empty the mail source (if it was processed fully) and unlock the file
- *
- * @return void
+ * Empty the mail source (if it was processed fully) and unlock the file.
*/
public function __destruct() {
if ($this->_leftToProcess === 0) {
*
* @param int $nr
* Number of the message to fetch.
- *
- * @return void
*/
public function markIgnored($nr) {
if ($this->_debug) {
*
* @param int $nr
* Number of the message to fetch.
- *
- * @return void
*/
public function markProcessed($nr) {
if ($this->_debug) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
require_once 'ezc/Base/src/ezc_bootstrap.php';
*
* @param int $nr
* Number of the message to fetch.
- *
- * @return void
*/
public function markIgnored($nr) {
if ($this->_debug) {
*
* @param int $nr
* Number of the message to fetch.
- *
- * @return void
*/
public function markProcessed($nr) {
if ($this->_debug) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* The mailing id of the mailing we're operating on
*
- * @int
+ * @var int
*/
protected $_mailingId;
/**
* The action that we are performing (in CRM_Core_Action terms)
*
- * @int
+ * @var int
*/
protected $_action;
/**
* Scheduled mailing.
*
- * @boolean
+ * @var boolean
*/
public $_scheduled;
/**
* Heart of the viewing process. The runner gets all the meta data for
* the contact and calls the appropriate type of page to view.
- *
- * @return void
*/
public function preProcess() {
$this->_unscheduled = $this->_archived = $archiveLinks = FALSE;
/**
* Run this page (figure out the action needed and perform it).
- *
- * @return void
*/
public function run() {
$this->preProcess();
}
}
elseif ($this->_action & CRM_Core_Action::RENEW) {
- //archive this mailing, CRM-3752.
+ // archive this mailing, CRM-3752.
if (CRM_Utils_Request::retrieve('confirmed', 'Boolean', $this)) {
- //set is_archived to 1
+ // set is_archived to 1
CRM_Core_DAO::setFieldValue('CRM_Mailing_DAO_Mailing', $this->_mailingId, 'is_archived', TRUE);
CRM_Utils_System::redirect($context);
}
$controller->setEmbedded(TRUE);
$controller->run();
- //hack to display results as per search
+ // hack to display results as per search
$rows = $controller->getRows($controller);
$this->assign('rows', $rows);
$url = CRM_Utils_System::url($urlString, $urlParams);
$session->pushUserContext($url);
- //CRM-6862 -run form cotroller after
- //selector, since it erase $_POST
+ // CRM-6862 -run form cotroller after
+ // selector, since it erase $_POST
$this->search();
return parent::run();
$clauses = array();
$title = $this->get('mailing_name');
- //echo " name=$title ";
+ // echo " name=$title ";
if ($title) {
$clauses[] = 'name LIKE %1';
if (strpos($title, '%') !== FALSE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Page_Common extends CRM_Core_Page {
protected $_type = NULL;
"reset=1&jid={$job_id}&qid={$queue_id}&h={$hash}&confirm=1"
);
$this->assign('confirmURL', $confirmURL);
- //push context for further process CRM-4431
+ // push context for further process CRM-4431
$session = CRM_Core_Session::singleton();
$session->pushUserContext($confirmURL);
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Page_Confirm extends CRM_Core_Page {
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Run this page (figure out the action needed and perform it).
- *
- * @return void
*/
public function run() {
$selector = &new CRM_Mailing_Selector_Event(
$mailing_id = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
- //assign backurl
+ // assign backurl
$context = CRM_Utils_Request::retrieve('context', 'String', $this);
if ($context == 'activitySelector') {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Page_Optout extends CRM_Mailing_Page_Common {
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Run this page (figure out the action needed and perform it).
- *
- * @return void
*/
public function run() {
$options = array();
$session->getVars($options, "CRM_Mailing_Controller_Send_$qfKey");
- //get the options if control come from search context, CRM-3711
+ // get the options if control come from search context, CRM-3711
if (empty($options)) {
$session->getVars($options, "CRM_Contact_Controller_Search_$qfKey");
}
$mailing->id
);
- //get details of contact with token value including Custom Field Token Values.CRM-3734
+ // get details of contact with token value including Custom Field Token Values.CRM-3734
$returnProperties = $mailing->getReturnProperties();
$params = array('contact_id' => $session->get('userID'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page to display / edit the header / footer of a mailing
- *
+ * Page to display / edit the header / footer of a mailing.
*/
class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic {
public $_mailing_id;
$report = CRM_Mailing_BAO_Mailing::report($this->_mailing_id);
- //get contents of mailing
+ // get contents of mailing
CRM_Mailing_BAO_Mailing::getMailingContent($report, $this);
- //assign backurl
+ // assign backurl
$context = CRM_Utils_Request::retrieve('context', 'String', $this);
$cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Page_Resubscribe extends CRM_Mailing_Page_Common {
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Mailing_Page_Unsubscribe extends CRM_Mailing_Page_Common {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * a page for mailing preview
+ * A page for mailing preview.
*/
class CRM_Mailing_Page_View extends CRM_Core_Page {
protected $_mailingID;
/**
* Lets do permission checking here.
- * First check for valid mailing, if false return fatal
- * Second check for visibility
- * Call a hook to see if hook wants to override visibility setting
+ * First check for valid mailing, if false return fatal.
+ * Second check for visibility.
+ * Call a hook to see if hook wants to override visibility setting.
*/
public function checkPermission() {
if (!$this->_mailing) {
* @param int $contactID
* @param bool $print
* @param bool $allowID
- *
- * @return void
*/
public function run($id = NULL, $contactID = NULL, $print = TRUE, $allowID = FALSE) {
if (is_numeric($id)) {
// get contact detail and compose if contact id exists
$returnProperties = $this->_mailing->getReturnProperties();
if (isset($this->_contactID)) {
- //get details of contact with token value including Custom Field Token Values.CRM-3734
+ // get details of contact with token value including Custom Field Token Values.CRM-3734
$params = array('contact_id' => $this->_contactID);
$details = CRM_Utils_Token::getTokenDetails($params,
$returnProperties,
$contactId = $this->_contactID;
}
else {
- //get tokens that are not contact specific resolved
+ // get tokens that are not contact specific resolved
$params = array('contact_id' => 0);
$details = CRM_Utils_Token::getAnonymousTokenDetails($params,
$returnProperties,
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class holds all the Pseudo constants that are specific to Mass mailing. This avoids
- * polluting the core class and isolates the mass mailer class
+ * polluting the core class and isolates the mass mailer class.
*/
class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Returns total number of rows for the query.
*
- * @param
+ * @param string $action
*
* @return int
* Total number of rows
$mailing = CRM_Mailing_BAO_Mailing::getTableName();
$mailingACL = CRM_Mailing_BAO_Mailing::mailingACL();
- //get the where clause.
+ // get the where clause.
$params = array();
$whereClause = "$mailingACL AND " . $this->whereClause($params);
if (CRM_Mailing_Info::workflowEnabled()) {
$allAccess = FALSE;
$workFlow = TRUE;
- //supercedes all permission
+ // supercedes all permission
if (CRM_Core_Permission::check('access CiviMail')) {
$allAccess = TRUE;
}
}
$rows = &$mailing->getRows($offset, $rowCount, $sort, $whereClause, $params);
- //get the search base mailing Ids, CRM-3711.
+ // get the search base mailing Ids, CRM-3711.
$searchMailings = $mailing->searchMailingIDs();
- //check for delete CRM-4418
+ // check for delete CRM-4418
$allowToDelete = CRM_Core_Permission::check('delete in CiviMail');
if ($output != CRM_Core_Selector_Controller::EXPORT) {
- //create the appropriate $op to use for hook_civicrm_links
+ // create the appropriate $op to use for hook_civicrm_links
$pageTypes = array('view', 'mailing', 'browse');
if ($this->_parent->_unscheduled) {
$pageTypes[] = 'unscheduled';
}
}
- //check for delete permission.
+ // check for delete permission.
if ($allowToDelete) {
$actionMask |= CRM_Core_Action::DELETE;
}
if ($actionMask == NULL) {
$actionMask = CRM_Core_Action::ADD;
}
- //get status strings as per locale settings CRM-4411.
+ // get status strings as per locale settings CRM-4411.
$rows[$key]['status'] = CRM_Mailing_BAO_MailingJob::status($row['status']);
$rows[$key]['action'] = CRM_Core_Action::formLink($actionLinks,
$row['id']
);
- //unset($rows[$key]['id']);
+ // unset($rows[$key]['id']);
// if the scheduled date is 0, replace it with an empty string
if ($rows[$key]['scheduled_iso'] == '0000-00-00 00:00:00') {
$rows[$key]['scheduled'] = '';
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class is used to retrieve and display a range of
* contacts that match the given criteria (specifically for
* results of advanced search options.
- *
*/
class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
* Returns total number of rows for the query.
*
- * @param
+ * @param string $action
*
* @return int
* Total number of rows
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class is used to retrieve and display a range of
* contacts that match the given criteria (specifically for
* results of advanced search options.
- *
*/
class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
* Returns total number of rows for the query.
*
- * @param
+ * @param string $action
*
* @return int
* Total number of rows
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* class to represent the actions that can be performed on a group of contacts
- * used by the search forms
+ * used by the search forms.
*
*/
class CRM_Mailing_Task {
/**
- * The task array
+ * The task array.
*
* @var array
*/
static $_tasks = NULL;
/**
- * The optional task array
+ * The optional task array.
*
* @var array
*/
/**
* These tasks are the core set of tasks that the user can perform
- * on a contact / group of contacts
+ * on a contact / group of contacts.
*
* @return array
- * the set of tasks for a group of contacts
+ * the set of tasks for a group of contacts.
*/
public static function &tasks() {
if (!(self::$_tasks)) {
/**
* These tasks are the core set of task titles
- * on mailing recipients
+ * on mailing recipients.
*
* @return array
- * the set of task titles
+ * the set of task titles.
*/
public static function &taskTitles() {
return array();
/**
* Show tasks selectively based on the permission level
- * of the user
+ * of the user.
*
* @param int $permission
*
/**
* These tasks are the core set of tasks that the user can perform.
- * on mailing recipients
+ * on mailing recipients.
*
* @param int $value
*
projects / civicrm-core.git / commitdiff