3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2019
35 * Class CRM_Activity_ActionMapping
37 * This defines the scheduled-reminder functionality for contact
38 * entities. It is useful for, e.g., sending a reminder based on
39 * birth date, modification date, or other custom dates on
42 class CRM_Activity_ActionMapping
extends \Civi\ActionSchedule\Mapping
{
45 * The value for civicrm_action_schedule.mapping_id which identifies the
48 * Note: This value is chosen to match legacy DB IDs.
50 const ACTIVITY_MAPPING_ID
= 1;
53 * Register Activity-related action mappings.
55 * @param \Civi\ActionSchedule\Event\MappingRegisterEvent $registrations
57 public static function onRegisterActionMappings(\Civi\ActionSchedule\Event\MappingRegisterEvent
$registrations) {
58 $registrations->register(CRM_Activity_ActionMapping
::create([
59 'id' => CRM_Activity_ActionMapping
::ACTIVITY_MAPPING_ID
,
60 'entity' => 'civicrm_activity',
61 'entity_label' => ts('Activity'),
62 'entity_value' => 'activity_type',
63 'entity_value_label' => ts('Activity Type'),
64 'entity_status' => 'activity_status',
65 'entity_status_label' => ts('Activity Status'),
66 'entity_date_start' => 'activity_date_time',
71 * Get a list of recipient types.
73 * Note: A single schedule may filter on *zero* or *one* recipient types.
74 * When an admin chooses a value, it's stored in $schedule->recipient.
77 * array(string $value => string $label).
78 * Ex: array('assignee' => 'Activity Assignee').
80 public function getRecipientTypes() {
81 return \CRM_Core_OptionGroup
::values('activity_contacts');
85 * Generate a query to locate recipients who match the given
88 * @param \CRM_Core_DAO_ActionSchedule $schedule
89 * The schedule as configured by the administrator.
90 * @param string $phase
91 * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST.
93 * @param array $defaultParams
95 * @return \CRM_Utils_SQL_Select
96 * @see RecipientBuilder
98 public function createQuery($schedule, $phase, $defaultParams) {
99 $selectedValues = (array) \CRM_Utils_Array
::explodePadded($schedule->entity_value
);
100 $selectedStatuses = (array) \CRM_Utils_Array
::explodePadded($schedule->entity_status
);
102 $query = \CRM_Utils_SQL_Select
::from("{$this->entity} e")->param($defaultParams);
103 $query['casAddlCheckFrom'] = 'civicrm_activity e';
104 $query['casContactIdField'] = 'r.contact_id';
105 $query['casEntityIdField'] = 'e.id';
106 $query['casContactTableAlias'] = NULL;
107 $query['casDateField'] = 'e.activity_date_time';
109 if (!is_null($schedule->limit_to
)) {
110 $activityContacts = \CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
111 if ($schedule->limit_to
== 0 ||
!isset($activityContacts[$schedule->recipient
])) {
112 $recipientTypeId = \CRM_Utils_Array
::key('Activity Targets', $activityContacts);
115 $recipientTypeId = $schedule->recipient
;
117 $query->join('r', "INNER JOIN civicrm_activity_contact r ON r.activity_id = e.id AND record_type_id = {$recipientTypeId}");
119 // build where clause
120 if (!empty($selectedValues)) {
121 $query->where("e.activity_type_id IN (#selectedValues)")
122 ->param('selectedValues', $selectedValues);
125 $query->where("e.activity_type_id IS NULL");
128 if (!empty($selectedStatuses)) {
129 $query->where("e.status_id IN (#selectedStatuss)")
130 ->param('selectedStatuss', $selectedStatuses);
132 $query->where('e.is_current_revision = 1 AND e.is_deleted = 0');