/**
* @param array $filters
- * Filter by property (e.g. 'id', 'entity_value').
+ * Filter by property (e.g. 'id').
* @return array
* Array(scalar $id => Mapping $mapping).
*/
$_action_mapping = $event->getMappings();
}
- if ($filters === NULL) {
+ if (empty($filters)) {
return $_action_mapping;
}
-
- $result = array();
- foreach ($_action_mapping as $mappingId => $mapping) {
- $match = TRUE;
- foreach ($filters as $filterField => $filterValue) {
- if ($mapping->{$filterField} != $filterValue) {
- $match = FALSE;
- }
- }
- if ($match) {
- $result[$mappingId] = $mapping;
- }
+ elseif (isset($filters['id'])) {
+ return array(
+ $filters['id'] => $_action_mapping[$filters['id']],
+ );
}
- return $result;
+ else {
+ throw new CRM_Core_Exception("getMappings() called with unsupported filter: " . implode(', ', array_keys($filters)));
+ }
+ }
+
+ /**
+ * @param string|int $id
+ * @return \Civi\ActionSchedule\Mapping|NULL
+ */
+ public static function getMapping($id) {
+ $mappings = self::getMappings();
+ return isset($mappings[$id]) ? $mappings[$id] : NULL;
}
/**
*/
public static function getSelection($id = NULL) {
$mappings = CRM_Core_BAO_ActionSchedule::getMappings();
+ $selectedMapping = $mappings[$id ? $id : 1];
- $entityValueLabels = $entityStatusLabels = $dateFieldLabels = array();
- $entityRecipientLabels = $entityRecipientNames = array();
-
- if (!$id) {
- $id = 1;
+ $entityValueLabels = array();
+ foreach ($mappings as $mapping) {
+ /** @var \Civi\ActionSchedule\Mapping $mapping */
+ $entityValueLabels[$mapping->getId()] = $mapping->getValueLabels();
+ $valueLabel = array('- ' . strtolower($mapping->getValueHeader()) . ' -');
+ $entityValueLabels[$mapping->getId()] = $valueLabel + $entityValueLabels[$mapping->getId()];
}
+ $entityStatusLabels = array();
foreach ($mappings as $mapping) {
/** @var \Civi\ActionSchedule\Mapping $mapping */
-
- $entityValueLabels[$mapping->id] = $mapping->getValueLabels();
- // Not sure why: everything *except* contact-dates have a $valueLabel.
- if ($mapping->entity_value !== 'civicrm_contact') {
- $valueLabel = array('- ' . strtolower($mapping->entity_value_label) . ' -');
- $entityValueLabels[$mapping->id] = $valueLabel + $entityValueLabels[$mapping->id];
- }
-
- if ($mapping->id == $id) {
- $dateFieldLabels = $mapping->getDateFields();
- $entityRecipientLabels = array($mapping->entity_recipient => $mapping->getRecipientTypes());
- $entityRecipientNames = array_combine(array_keys($entityRecipientLabels[$mapping->entity_recipient]), array_keys($entityRecipientLabels[$mapping->entity_recipient]));
- }
-
- $statusLabel = array('- ' . strtolower($mapping->entity_status_label) . ' -');
- $entityStatusLabels[$mapping->id] = $entityValueLabels[$mapping->id];
- foreach ($entityStatusLabels[$mapping->id] as $kkey => & $vval) {
+ $statusLabel = array('- ' . strtolower($mapping->getStatusHeader()) . ' -');
+ $entityStatusLabels[$mapping->getId()] = $entityValueLabels[$mapping->getId()];
+ foreach ($entityStatusLabels[$mapping->getId()] as $kkey => & $vval) {
$vval = $statusLabel + $mapping->getStatusLabels($kkey);
}
}
+ $entityRecipientLabels = $selectedMapping->getRecipientTypes() + self::getAdditionalRecipients();
+
return array(
- 'sel1' => CRM_Utils_Array::collect('entity_label', $mappings),
+ 'sel1' => CRM_Utils_Array::collectMethod('getLabel', $mappings),
'sel2' => $entityValueLabels,
'sel3' => $entityStatusLabels,
- 'sel4' => $dateFieldLabels,
+ 'sel4' => $selectedMapping->getDateFields(),
'sel5' => $entityRecipientLabels,
- 'entityMapping' => CRM_Utils_Array::collect('entity', $mappings),
- 'recipientMapping' => $entityRecipientNames,
+ 'entityMapping' => CRM_Utils_Array::collectMethod('getEntity', $mappings),
+ 'recipientMapping' => array_combine(array_keys($entityRecipientLabels), array_keys($entityRecipientLabels)),
);
}
foreach ($mappings as $mapping) {
/** @var \Civi\ActionSchedule\Mapping $mapping */
$dateFieldLabels = $mapping->getDateFields();
- $entityRecipientLabels = $mapping->getRecipientTypes(!$isLimit);
+ $entityRecipientLabels = $mapping->getRecipientTypes(!$isLimit) + self::getAdditionalRecipients();
}
return array(
* @param bool $namesOnly
* Return simple list of names.
*
- * @param null $entityValue
- * @param int $id
+ * @param \Civi\ActionSchedule\Mapping|NULL $filterMapping
+ * Filter by the schedule's mapping type.
+ * @param int $filterValue
+ * Filter by the schedule's entity_value.
*
* @return array
* (reference) reminder list
*/
- public static function &getList($namesOnly = FALSE, $entityValue = NULL, $id = NULL) {
+ public static function &getList($namesOnly = FALSE, $filterMapping = NULL, $filterValue = NULL) {
$query = "
SELECT
title,
";
$queryParams = array();
$where = " WHERE 1 ";
- if ($entityValue and $id) {
- $mappings = self::getMappings(array(
- 'entity_value' => $entityValue,
- ));
- $mappingIds = implode(',', array_keys($mappings));
- $where .= " AND cas.entity_value = %1 AND cas.mapping_id IN ($mappingIds)";
- $queryParams[1] = array($id, 'Integer');
+ if ($filterMapping and $filterValue) {
+ $where .= " AND cas.entity_value = %1 AND cas.mapping_id = %2";
+ $queryParams[1] = array($filterValue, 'Integer');
+ $queryParams[2] = array($filterMapping->getId(), 'String');
}
$where .= " AND cas.used_for IS NULL";
$query .= $where;
$dao = CRM_Core_DAO::executeQuery($query, $queryParams);
while ($dao->fetch()) {
- /** @var Civi\ActionSchedule\Mapping $mapping */
- $mapping = CRM_Utils_Array::first(self::getMappings(array(
+ /** @var Civi\ActionSchedule\Mapping $filterMapping */
+ $filterMapping = CRM_Utils_Array::first(self::getMappings(array(
'id' => $dao->mapping_id,
)));
$list[$dao->id]['id'] = $dao->id;
$list[$dao->id]['start_action_condition'] = $dao->start_action_condition;
$list[$dao->id]['entityDate'] = ucwords(str_replace('_', ' ', $dao->entityDate));
$list[$dao->id]['absolute_date'] = $dao->absolute_date;
- $list[$dao->id]['entity'] = $mapping->entity_label;
+ $list[$dao->id]['entity'] = $filterMapping->getLabel();
$list[$dao->id]['value'] = implode(', ', CRM_Utils_Array::subset(
- $mapping->getValueLabels(),
+ $filterMapping->getValueLabels(),
explode(CRM_Core_DAO::VALUE_SEPARATOR, $dao->entityValueIds)
));
$list[$dao->id]['status'] = implode(', ', CRM_Utils_Array::subset(
- $mapping->getStatusLabels($dao->entityValueIds),
+ $filterMapping->getStatusLabels($dao->entityValueIds),
explode(CRM_Core_DAO::VALUE_SEPARATOR, $dao->entityStatusIds)
));
$list[$dao->id]['is_repeat'] = $dao->is_repeat;
$actionSchedule->find();
while ($actionSchedule->fetch()) {
+ /** @var \Civi\ActionSchedule\Mapping $mapping */
$mapping = CRM_Utils_Array::first(self::getMappings(array(
'id' => $mappingID,
)));
-
- // note: $where - this filtering applies for both
- // 'limit to' and 'addition to' options
- // $limitWhere - this filtering applies only for
- // 'limit to' option
- $select = $join = $where = $limitWhere = array();
- $selectColumns = "contact_id, entity_id, entity_table, action_schedule_id";
- $limitTo = $actionSchedule->limit_to;
- $value = explode(CRM_Core_DAO::VALUE_SEPARATOR,
- trim($actionSchedule->entity_value, CRM_Core_DAO::VALUE_SEPARATOR)
- );
- $value = implode(',', $value);
-
- $status = explode(CRM_Core_DAO::VALUE_SEPARATOR,
- trim($actionSchedule->entity_status, CRM_Core_DAO::VALUE_SEPARATOR)
- );
- $status = implode(',', $status);
-
- $anniversary = FALSE;
-
- if (!CRM_Utils_System::isNull($mapping->entity_recipient)) {
- if ($mapping->entity_recipient == 'event_contacts') {
- $recipientOptions = CRM_Core_OptionGroup::values($mapping->entity_recipient, FALSE, FALSE, FALSE, NULL, 'name', TRUE, FALSE, 'name');
- }
- else {
- $recipientOptions = CRM_Core_OptionGroup::values($mapping->entity_recipient, FALSE, FALSE, FALSE, NULL, 'name');
- }
- }
- $from = "{$mapping->entity} e";
-
- if ($mapping->entity == 'civicrm_activity') {
- $contactField = 'r.contact_id';
- $table = 'civicrm_activity e';
- $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
- $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
- $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
- $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
-
- if (!is_null($limitTo)) {
- if ($limitTo == 0) {
- // including the activity target contacts if 'in addition' is defined
- $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
- }
- else {
- switch (CRM_Utils_Array::value($actionSchedule->recipient, $recipientOptions)) {
- case 'Activity Assignees':
- $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$assigneeID}";
- break;
-
- case 'Activity Source':
- $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$sourceID}";
- break;
-
- default:
- case 'Activity Targets':
- $join[] = "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$targetID}";
- break;
- }
- }
- }
- // build where clause
- if (!empty($value)) {
- $where[] = "e.activity_type_id IN ({$value})";
- }
- else {
- $where[] = "e.activity_type_id IS NULL";
- }
- if (!empty($status)) {
- $where[] = "e.status_id IN ({$status})";
- }
- $where[] = ' e.is_current_revision = 1 ';
- $where[] = ' e.is_deleted = 0 ';
-
- $dateField = 'e.activity_date_time';
- }
-
- if ($mapping->entity == 'civicrm_participant') {
- $table = 'civicrm_event r';
- $contactField = 'e.contact_id';
- $join[] = 'INNER JOIN civicrm_event r ON e.event_id = r.id';
- if ($actionSchedule->recipient_listing && $limitTo) {
- $rList = explode(CRM_Core_DAO::VALUE_SEPARATOR,
- trim($actionSchedule->recipient_listing, CRM_Core_DAO::VALUE_SEPARATOR)
- );
- $rList = implode(',', $rList);
-
- switch (CRM_Utils_Array::value($actionSchedule->recipient, $recipientOptions)) {
- case 'participant_role':
- $where[] = "e.role_id IN ({$rList})";
- break;
-
- default:
- break;
- }
- }
-
- // build where clause
- if (!empty($value)) {
- $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IN ({$value})" : "r.id IN ({$value})";
- }
- else {
- $where[] = ($mapping->entity_value == 'event_type') ? "r.event_type_id IS NULL" : "r.id IS NULL";
- }
-
- // participant status criteria not to be implemented
- // for additional recipients
- if (!empty($status)) {
- $limitWhere[] = "e.status_id IN ({$status})";
- }
-
- $where[] = 'r.is_active = 1';
- $where[] = 'r.is_template = 0';
- $dateField = str_replace('event_', 'r.', $actionSchedule->start_action_date);
- }
-
- $notINClause = '';
- if ($mapping->entity == 'civicrm_membership') {
- $contactField = 'e.contact_id';
- $table = 'civicrm_membership e';
- // build where clause
- if ($status == 2) {
- //auto-renew memberships
- $where[] = "e.contribution_recur_id IS NOT NULL ";
- }
- elseif ($status == 1) {
- $where[] = "e.contribution_recur_id IS NULL ";
- }
-
- // build where clause
- if (!empty($value)) {
- $where[] = "e.membership_type_id IN ({$value})";
- }
- else {
- $where[] = "e.membership_type_id IS NULL";
- }
-
- $where[] = "( e.is_override IS NULL OR e.is_override = 0 )";
- $dateField = str_replace('membership_', 'e.', $actionSchedule->start_action_date);
- $notINClause = CRM_Core_BAO_ActionSchedule::permissionedRelationships($contactField);
-
- $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(NULL, "(is_current_member = 1 OR name = 'Expired')", 'id');
- $mStatus = implode(',', $membershipStatus);
- $where[] = "e.status_id IN ({$mStatus})";
-
- // We are not tracking the reference date for 'repeated' schedule reminders,
- // for further details please check CRM-15376
- if ($actionSchedule->start_action_date && $actionSchedule->is_repeat == FALSE) {
- $select[] = $dateField;
- $selectColumns = "reference_date, " . $selectColumns;
- }
- }
-
- if ($mapping->entity == 'civicrm_contact') {
- $contactFields = array(
- 'birth_date',
- 'created_date',
- 'modified_date',
- );
- if (in_array($value, $contactFields)) {
- $dateDBField = $value;
- $table = 'civicrm_contact e';
- $contactField = 'e.id';
- $where[] = 'e.is_deleted = 0';
- $where[] = 'e.is_deceased = 0';
- }
- else {
- //custom field
- $customFieldParams = array('id' => substr($value, 7));
- $customGroup = $customField = array();
- CRM_Core_BAO_CustomField::retrieve($customFieldParams, $customField);
- $dateDBField = $customField['column_name'];
- $customGroupParams = array('id' => $customField['custom_group_id'], $customGroup);
- CRM_Core_BAO_CustomGroup::retrieve($customGroupParams, $customGroup);
- $from = $table = "{$customGroup['table_name']} e";
- $contactField = 'e.entity_id';
- $where[] = '1'; // possible to have no "where" in this case
- }
-
- $status_ = explode(',', $status);
- if (in_array(2, $status_)) {
- // anniversary mode:
- $dateField = 'DATE_ADD(e.' . $dateDBField . ', INTERVAL ROUND(DATEDIFF(DATE(' . $now . '), e.' . $dateDBField . ') / 365) YEAR)';
- $anniversary = TRUE;
- }
- else {
- // regular mode:
- $dateField = 'e.' . $dateDBField;
- }
- }
-
- // CRM-13577 Introduce Smart Groups Handling
- if ($actionSchedule->group_id) {
-
- // Need to check if its a smart group or not
- // Then decide which table to join onto the query
- $group = CRM_Contact_DAO_Group::getTableName();
-
- // Get the group information
- $sql = "
-SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
-FROM $group
-WHERE $group.id = {$actionSchedule->group_id}
-";
-
- $groupDAO = CRM_Core_DAO::executeQuery($sql);
- $isSmartGroup = FALSE;
- if (
- $groupDAO->fetch() &&
- !empty($groupDAO->saved_search_id)
- ) {
- // Check that the group is in place in the cache and up to date
- CRM_Contact_BAO_GroupContactCache::check($actionSchedule->group_id);
- // Set smart group flag
- $isSmartGroup = TRUE;
- }
- }
- // CRM-13577 End Introduce Smart Groups Handling
-
- if ($limitTo) {
- if ($actionSchedule->group_id) {
- // CRM-13577 If smart group then use Cache table
- if ($isSmartGroup) {
- $join[] = "INNER JOIN civicrm_group_contact_cache grp ON {$contactField} = grp.contact_id";
- $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
- }
- else {
- $join[] = "INNER JOIN civicrm_group_contact grp ON {$contactField} = grp.contact_id AND grp.status = 'Added'";
- $where[] = "grp.group_id IN ({$actionSchedule->group_id})";
- }
- }
- elseif (!empty($actionSchedule->recipient_manual)) {
- $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
- $where[] = "{$contactField} IN ({$rList})";
- }
- }
- elseif (!is_null($limitTo)) {
- $addGroup = $addWhere = '';
- if ($actionSchedule->group_id) {
- // CRM-13577 If smart group then use Cache table
- if ($isSmartGroup) {
- $addGroup = " INNER JOIN civicrm_group_contact_cache grp ON c.id = grp.contact_id";
- $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
- }
- else {
- $addGroup = " INNER JOIN civicrm_group_contact grp ON c.id = grp.contact_id AND grp.status = 'Added'";
- $addWhere = " grp.group_id IN ({$actionSchedule->group_id})";
- }
- }
- if (!empty($actionSchedule->recipient_manual)) {
- $rList = CRM_Utils_Type::escape($actionSchedule->recipient_manual, 'String');
- $addWhere = "c.id IN ({$rList})";
- }
- }
-
- $select[] = "{$contactField} as contact_id";
- $select[] = 'e.id as entity_id';
- $select[] = "'{$mapping->entity}' as entity_table";
- $select[] = "{$actionSchedule->id} as action_schedule_id";
- $reminderJoinClause = "civicrm_action_log reminder ON reminder.contact_id = {$contactField} AND
-reminder.entity_id = e.id AND
-reminder.entity_table = '{$mapping->entity}' AND
-reminder.action_schedule_id = %1";
-
- if ($anniversary) {
- // only consider reminders less than 11 months ago
- $reminderJoinClause .= " AND reminder.action_date_time > DATE_SUB({$now}, INTERVAL 11 MONTH)";
- }
-
- if ($table != 'civicrm_contact e') {
- $join[] = "INNER JOIN civicrm_contact c ON c.id = {$contactField} AND c.is_deleted = 0 AND c.is_deceased = 0 ";
- }
-
- $multilingual = CRM_Core_I18n::isMultilingual();
- if ($multilingual && !empty($actionSchedule->filter_contact_language)) {
- $tableAlias = ($table != 'civicrm_contact e') ? 'c' : 'e';
-
- // get language filter for the schedule
- $filter_contact_language = explode(CRM_Core_DAO::VALUE_SEPARATOR, $actionSchedule->filter_contact_language);
- $w = '';
- if (($key = array_search(CRM_Core_I18n::NONE, $filter_contact_language)) !== FALSE) {
- $w .= "{$tableAlias}.preferred_language IS NULL OR {$tableAlias}.preferred_language = '' OR ";
- unset($filter_contact_language[$key]);
- }
- if (count($filter_contact_language) > 0) {
- $w .= "{$tableAlias}.preferred_language IN ('" . implode("','", $filter_contact_language) . "')";
- }
- $where[] = "($w)";
- }
-
- if ($actionSchedule->start_action_date) {
- $startDateClause = array();
- $op = ($actionSchedule->start_action_condition == 'before' ? '<=' : '>=');
- $operator = ($actionSchedule->start_action_condition == 'before' ? 'DATE_SUB' : 'DATE_ADD');
- $date = $operator . "({$dateField}, INTERVAL {$actionSchedule->start_action_offset} {$actionSchedule->start_action_unit})";
- $startDateClause[] = "'{$now}' >= {$date}";
- if ($mapping->entity == 'civicrm_participant') {
- $startDateClause[] = $operator . "({$now}, INTERVAL 1 DAY ) {$op} " . $dateField;
- }
- else {
- $startDateClause[] = "DATE_SUB({$now}, INTERVAL 1 DAY ) <= {$date}";
- }
-
- $startDate = implode(' AND ', $startDateClause);
- }
- elseif ($actionSchedule->absolute_date) {
- $startDate = "DATEDIFF(DATE('{$now}'),'{$actionSchedule->absolute_date}') = 0";
- }
-
- // ( now >= date_built_from_start_time ) OR ( now = absolute_date )
- $dateClause = "reminder.id IS NULL AND {$startDate}";
-
- // start composing query
- $selectClause = 'SELECT ' . implode(', ', $select);
- $fromClause = "FROM $from";
- $joinClause = !empty($join) ? implode(' ', $join) : '';
- $whereClause = 'WHERE ' . implode(' AND ', $where);
- $limitWhereClause = '';
- if (!empty($limitWhere)) {
- $limitWhereClause = ' AND ' . implode(' AND ', $limitWhere);
- }
-
- $query = "
-INSERT INTO civicrm_action_log ({$selectColumns})
-{$selectClause}
-{$fromClause}
-{$joinClause}
-LEFT JOIN {$reminderJoinClause}
-{$whereClause} {$limitWhereClause} AND {$dateClause} {$notINClause}
-";
-
- // In some cases reference_date got outdated due to many reason e.g. In Membership renewal end_date got extended
- // which means reference date mismatches with the end_date where end_date may be used as the start_action_date
- // criteria for some schedule reminder so in order to send new reminder we INSERT new reminder with new reference_date
- // value via UNION operation
- if (strpos($selectColumns, 'reference_date') !== FALSE) {
- $dateClause = str_replace('reminder.id IS NULL', 'reminder.id IS NOT NULL', $dateClause);
- $referenceQuery = "
-INSERT INTO civicrm_action_log ({$selectColumns})
-{$selectClause}
-{$fromClause}
-{$joinClause}
- LEFT JOIN {$reminderJoinClause}
-{$whereClause} {$limitWhereClause} {$notINClause} AND {$dateClause} AND
- reminder.action_date_time IS NOT NULL AND
- reminder.reference_date IS NOT NULL
-GROUP BY reminder.id, reminder.reference_date
-HAVING reminder.id = MAX(reminder.id) AND reminder.reference_date <> {$dateField}
-";
- }
-
- CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
-
- if (!empty($referenceQuery)) {
- CRM_Core_DAO::executeQuery($referenceQuery, array(1 => array($actionSchedule->id, 'Integer')));
- }
-
- $isSendToAdditionalContacts = (!is_null($limitTo) && $limitTo == 0 && (!empty($addGroup) || !empty($addWhere))) ? TRUE : FALSE;
- if ($isSendToAdditionalContacts) {
- $contactTable = "civicrm_contact c";
- $addSelect = "SELECT c.id as contact_id, c.id as entity_id, 'civicrm_contact' as entity_table, {$actionSchedule->id} as action_schedule_id";
- $additionReminderClause = "civicrm_action_log reminder ON reminder.contact_id = c.id AND
- reminder.entity_id = c.id AND
- reminder.entity_table = 'civicrm_contact' AND
- reminder.action_schedule_id = {$actionSchedule->id}";
- $addWhereClause = '';
- if ($addWhere) {
- $addWhereClause = "AND {$addWhere}";
- }
- $insertAdditionalSql = "
-INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id)
-{$addSelect}
-FROM ({$contactTable})
-LEFT JOIN {$additionReminderClause}
-{$addGroup}
-WHERE c.is_deleted = 0 AND c.is_deceased = 0
-{$addWhereClause}
-
-AND reminder.id IS NULL
-AND c.id NOT IN (
- SELECT rem.contact_id
- FROM civicrm_action_log rem INNER JOIN {$mapping->entity} e ON rem.entity_id = e.id
- WHERE rem.action_schedule_id = {$actionSchedule->id}
- AND rem.entity_table = '{$mapping->entity}'
- )
-GROUP BY c.id
-";
- CRM_Core_DAO::executeQuery($insertAdditionalSql);
- }
- // if repeat is turned ON:
- if ($actionSchedule->is_repeat) {
- $repeatEvent = ($actionSchedule->end_action == 'before' ? 'DATE_SUB' : 'DATE_ADD') . "({$dateField}, INTERVAL {$actionSchedule->end_frequency_interval} {$actionSchedule->end_frequency_unit})";
-
- if ($actionSchedule->repetition_frequency_unit == 'day') {
- $interval = "{$actionSchedule->repetition_frequency_interval} DAY";
- }
- elseif ($actionSchedule->repetition_frequency_unit == 'week') {
- $interval = "{$actionSchedule->repetition_frequency_interval} WEEK";
- }
- elseif ($actionSchedule->repetition_frequency_unit == 'month') {
- $interval = "{$actionSchedule->repetition_frequency_interval} MONTH";
- }
- elseif ($actionSchedule->repetition_frequency_unit == 'year') {
- $interval = "{$actionSchedule->repetition_frequency_interval} YEAR";
- }
- else {
- $interval = "{$actionSchedule->repetition_frequency_interval} HOUR";
- }
-
- // (now <= repeat_end_time )
- $repeatEventClause = "'{$now}' <= {$repeatEvent}";
- // diff(now && logged_date_time) >= repeat_interval
- $havingClause = "HAVING TIMESTAMPDIFF(HOUR, latest_log_time, CAST({$now} AS datetime)) >= TIMESTAMPDIFF(HOUR, latest_log_time, DATE_ADD(latest_log_time, INTERVAL $interval))";
- $groupByClause = 'GROUP BY reminder.contact_id, reminder.entity_id, reminder.entity_table';
- $selectClause .= ', MAX(reminder.action_date_time) as latest_log_time';
- //CRM-15376 - do not send our reminders if original criteria no longer applies
- // the first part of the startDateClause array is the earliest the reminder can be sent. If the
- // event (e.g membership_end_date) has changed then the reminder may no longer apply
- // @todo - this only handles events that get moved later. Potentially they might get moved earlier
- $originalEventStartDateClause = empty($startDateClause) ? '' : 'AND' . $startDateClause[0];
- $sqlInsertValues = "{$selectClause}
-{$fromClause}
-{$joinClause}
-INNER JOIN {$reminderJoinClause}
-{$whereClause} {$limitWhereClause} AND {$repeatEventClause} {$originalEventStartDateClause} {$notINClause}
-{$groupByClause}
-{$havingClause}";
-
- $valsqlInsertValues = CRM_Core_DAO::executeQuery($sqlInsertValues, array(
- 1 => array(
- $actionSchedule->id,
- 'Integer',
- ),
- )
- );
-
- $arrValues = array();
- while ($valsqlInsertValues->fetch()) {
- $arrValues[] = "( {$valsqlInsertValues->contact_id}, {$valsqlInsertValues->entity_id}, '{$valsqlInsertValues->entity_table}',{$valsqlInsertValues->action_schedule_id} )";
- }
-
- $valString = implode(',', $arrValues);
-
- if ($valString) {
- $query = '
- INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
- CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
- }
-
- if ($isSendToAdditionalContacts) {
- $addSelect .= ', MAX(reminder.action_date_time) as latest_log_time';
- $sqlEndEventCheck = "
-SELECT * FROM {$table}
-{$whereClause} AND {$repeatEventClause} LIMIT 1";
-
- $daoCheck = CRM_Core_DAO::executeQuery($sqlEndEventCheck);
- if ($daoCheck->fetch()) {
- $valSqlAdditionInsert = "
-{$addSelect}
-FROM {$contactTable}
-{$addGroup}
-INNER JOIN {$additionReminderClause}
-WHERE {$addWhere} AND c.is_deleted = 0 AND c.is_deceased = 0
-GROUP BY reminder.contact_id
-{$havingClause}
-";
- $daoForVals = CRM_Core_DAO::executeQuery($valSqlAdditionInsert);
- $addValues = array();
- while ($daoForVals->fetch()) {
- $addValues[] = "( {$daoForVals->contact_id}, {$daoForVals->entity_id}, '{$daoForVals->entity_table}',{$daoForVals->action_schedule_id} )";
- }
- $valString = implode(',', $addValues);
-
- if ($valString) {
- $query = '
- INSERT INTO civicrm_action_log (contact_id, entity_id, entity_table, action_schedule_id) VALUES ' . $valString;
- CRM_Core_DAO::executeQuery($query);
- }
- }
- }
- }
+ $builder = new \Civi\ActionSchedule\RecipientBuilder($now, $actionSchedule, $mapping);
+ $builder->build();
}
}
- /**
- * @param $field
- *
- * @return null|string
- */
- public static function permissionedRelationships($field) {
- $query = '
-SELECT cm.id AS owner_id, cm.contact_id AS owner_contact, m.id AS slave_id, m.contact_id AS slave_contact, cmt.relationship_type_id AS relation_type, rel.contact_id_a, rel.contact_id_b, rel.is_permission_a_b, rel.is_permission_b_a
-FROM civicrm_membership m
-LEFT JOIN civicrm_membership cm ON cm.id = m.owner_membership_id
-LEFT JOIN civicrm_membership_type cmt ON cmt.id = m.membership_type_id
-LEFT JOIN civicrm_relationship rel ON ( ( rel.contact_id_a = m.contact_id AND rel.contact_id_b = cm.contact_id AND rel.relationship_type_id = cmt.relationship_type_id )
- OR ( rel.contact_id_a = cm.contact_id AND rel.contact_id_b = m.contact_id AND rel.relationship_type_id = cmt.relationship_type_id ) )
-WHERE m.owner_membership_id IS NOT NULL AND
- ( rel.is_permission_a_b = 0 OR rel.is_permission_b_a = 0)
-
-';
- $excludeIds = array();
- $dao = CRM_Core_DAO::executeQuery($query, array());
- while ($dao->fetch()) {
- if ($dao->slave_contact == $dao->contact_id_a && $dao->is_permission_a_b == 0) {
- $excludeIds[] = $dao->slave_contact;
- }
- elseif ($dao->slave_contact == $dao->contact_id_b && $dao->is_permission_b_a == 0) {
- $excludeIds[] = $dao->slave_contact;
- }
- }
-
- if (!empty($excludeIds)) {
- $clause = "AND {$field} NOT IN ( " . implode(', ', $excludeIds) . ' ) ';
- return $clause;
- }
- return NULL;
- }
-
/**
* @param null $now
* @param array $params
entity_value = %2";
$params = array(
- 1 => array($mappingID, 'Integer'),
+ 1 => array($mappingID, 'String'),
2 => array($id, 'Integer'),
);
return CRM_Core_DAO::singleValueQuery($queryString, $params);
* @return array
*/
public static function getRecipientListing($mappingID, $recipientType) {
- $options = array();
- if (!$mappingID || !$recipientType) {
- return $options;
+ if (!$mappingID) {
+ return array();
}
+ /** @var \Civi\ActionSchedule\Mapping $mapping */
$mapping = CRM_Utils_Array::first(CRM_Core_BAO_ActionSchedule::getMappings(array(
'id' => $mappingID,
)));
-
- switch ($mapping->entity) {
- case 'civicrm_participant':
- $eventContacts = CRM_Core_OptionGroup::values('event_contacts', FALSE, FALSE, FALSE, NULL, 'name', TRUE, FALSE, 'name');
- if (empty($eventContacts[$recipientType])) {
- return $options;
- }
- if ($eventContacts[$recipientType] == 'participant_role') {
- $options = CRM_Event_PseudoConstant::participantRole();
- }
- break;
- }
-
- return $options;
+ return $mapping->getRecipientListing($recipientType);
}
/**
protected static function createMailingActivity($actionSchedule, $mapping, $contactID, $entityID, $caseID) {
$session = CRM_Core_Session::singleton();
- if ($mapping->entity == 'civicrm_membership') {
+ if ($mapping->getEntity() == 'civicrm_membership') {
$activityTypeID
= CRM_Core_OptionGroup::getValue('activity_type', 'Membership Renewal Reminder', 'name');
}
}
/**
- * @param $mapping
- * @param $actionSchedule
+ * @param \Civi\ActionSchedule\MappingInterface $mapping
+ * @param \CRM_Core_DAO_ActionSchedule $actionSchedule
* @return string
*/
protected static function prepareMailingQuery($mapping, $actionSchedule) {
- $extraSelect = $extraJoin = $extraWhere = $extraOn = '';
-
- if ($mapping->entity == 'civicrm_activity') {
- $compInfo = CRM_Core_Component::getEnabledComponents();
- $extraSelect = ', ov.label as activity_type, e.id as activity_id';
- $extraJoin = "
-INNER JOIN civicrm_option_group og ON og.name = 'activity_type'
-INNER JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
- $extraOn = ' AND e.is_current_revision = 1 AND e.is_deleted = 0 ';
- if ($actionSchedule->limit_to == 0) {
- $extraJoin = "
-LEFT JOIN civicrm_option_group og ON og.name = 'activity_type'
-LEFT JOIN civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id";
- }
-
- //join for caseId
- // if CiviCase component is enabled
- if (array_key_exists('CiviCase', $compInfo)) {
- $extraSelect .= ", civicrm_case_activity.case_id as case_id";
- $extraJoin .= "
- LEFT JOIN `civicrm_case_activity` ON `e`.`id` = `civicrm_case_activity`.`activity_id`";
- }
- }
-
- if ($mapping->entity == 'civicrm_participant') {
- $extraSelect = ', ov.label as event_type, ev.title, ev.id as event_id, ev.start_date, ev.end_date, ev.summary, ev.description, address.street_address, address.city, address.state_province_id, address.postal_code, email.email as contact_email, phone.phone as contact_phone ';
-
- $extraJoin = "
-INNER JOIN civicrm_event ev ON e.event_id = ev.id
-INNER JOIN civicrm_option_group og ON og.name = 'event_type'
-INNER JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
-LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
-LEFT JOIN civicrm_address address ON address.id = lb.address_id
-LEFT JOIN civicrm_email email ON email.id = lb.email_id
-LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
-";
- if ($actionSchedule->limit_to == 0) {
- $extraJoin = "
-LEFT JOIN civicrm_event ev ON e.event_id = ev.id
-LEFT JOIN civicrm_option_group og ON og.name = 'event_type'
-LEFT JOIN civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
-LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
-LEFT JOIN civicrm_address address ON address.id = lb.address_id
-LEFT JOIN civicrm_email email ON email.id = lb.email_id
-LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
-";
- }
- }
-
- if ($mapping->entity == 'civicrm_membership') {
- $extraSelect = ', mt.minimum_fee as fee, e.id as id , e.join_date, e.start_date, e.end_date, ms.name as status, mt.name as type';
- $extraJoin = '
- INNER JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
- INNER JOIN civicrm_membership_status ms ON e.status_id = ms.id';
-
- if ($actionSchedule->limit_to == 0) {
- $extraJoin = '
- LEFT JOIN civicrm_membership_type mt ON e.membership_type_id = mt.id
- LEFT JOIN civicrm_membership_status ms ON e.status_id = ms.id';
- }
- }
+ $select = CRM_Utils_SQL_Select::from('civicrm_action_log reminder')
+ ->select("reminder.id as reminderID, reminder.contact_id as contactID, reminder.entity_table as entityTable, reminder.*, e.id AS entityID")
+ ->join('e', "!casMailingJoinType !casMappingEntity e ON !casEntityJoinExpr")
+ ->select("e.id as entityID, e.*")
+ ->where("reminder.action_schedule_id = #casActionScheduleId")
+ ->where("reminder.action_date_time IS NULL")
+ ->param(array(
+ 'casActionScheduleId' => $actionSchedule->id,
+ 'casMailingJoinType' => ($actionSchedule->limit_to == 0) ? 'LEFT JOIN' : 'INNER JOIN',
+ 'casMappingId' => $mapping->getId(),
+ 'casMappingEntity' => $mapping->getEntity(),
+ 'casEntityJoinExpr' => 'e.id = reminder.entity_id',
+ ));
- $entityJoinClause = "INNER JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
if ($actionSchedule->limit_to == 0) {
- $entityJoinClause = "LEFT JOIN {$mapping->entity} e ON e.id = reminder.entity_id";
- $extraWhere .= " AND (e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact')";
+ $select->where("e.id = reminder.entity_id OR reminder.entity_table = 'civicrm_contact'");
}
- $entityJoinClause .= $extraOn;
- $query = "
-SELECT reminder.id as reminderID, reminder.contact_id as contactID, reminder.entity_table as entityTable, reminder.*, e.id as entityID, e.* {$extraSelect}
-FROM civicrm_action_log reminder
-{$entityJoinClause}
-{$extraJoin}
-WHERE reminder.action_schedule_id = %1 AND reminder.action_date_time IS NULL
-{$extraWhere}";
- return $query;
+ \Civi\Core\Container::singleton()->get('dispatcher')
+ ->dispatch(
+ \Civi\ActionSchedule\Events::MAILING_QUERY,
+ new \Civi\ActionSchedule\Event\MailingQueryEvent($actionSchedule, $mapping, $select)
+ );
+
+ return $select->toSQL();
}
/**
- * @param TokenRow $tokenRow
+ * @param \Civi\Token\TokenRow $tokenRow
* @param CRM_Core_DAO_ActionSchedule $schedule
* @param int $toContactID
* @throws CRM_Core_Exception
}
/**
- * @param TokenRow $tokenRow
+ * @param \Civi\Token\TokenRow $tokenRow
* @param CRM_Core_DAO_ActionSchedule $schedule
* @param int $toContactID
* @return array
return NULL;
}
+ /**
+ * Get the list of generic recipient types supported by all entities/mappings.
+ *
+ * @return array
+ * array(mixed $value => string $label).
+ */
+ protected static function getAdditionalRecipients() {
+ return array(
+ 'manual' => ts('Choose Recipient(s)'),
+ 'group' => ts('Select Group'),
+ );
+ }
+
}
projects / civicrm-core.git / blobdiff