| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 5 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2018 | |
| 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | |
| 10 | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 12 | | under the terms of the GNU Affero General Public License | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 14 | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 18 | | See the GNU Affero General Public License for more details. | |
| 19 | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | |
| 21 | | License and the CiviCRM Licensing Exception along | |
| 22 | | with this program; if not, contact CiviCRM LLC | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 26 | +--------------------------------------------------------------------+ |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * Class CRM_Member_Tokens |
| 36 | * |
| 37 | * Generate "activity.*" tokens. |
| 38 | * |
| 39 | * This TokenSubscriber was produced by refactoring the code from the |
| 40 | * scheduled-reminder system with the goal of making that system |
| 41 | * more flexible. The current implementation is still coupled to |
| 42 | * scheduled-reminders. It would be good to figure out a more generic |
| 43 | * implementation which is not tied to scheduled reminders, although |
| 44 | * that is outside the current scope. |
| 45 | */ |
| 46 | class CRM_Activity_Tokens extends \Civi\Token\AbstractTokenSubscriber { |
| 47 | |
| 48 | /** |
| 49 | * CRM_Activity_Tokens constructor. |
| 50 | */ |
| 51 | public function __construct() { |
| 52 | parent::__construct('activity', array_merge( |
| 53 | array( |
| 54 | 'activity_id' => ts('Activity ID'), |
| 55 | 'activity_type' => ts('Activity Type'), |
| 56 | 'subject' => ts('Activity Subject'), |
| 57 | 'details' => ts('Activity Details'), |
| 58 | 'activity_date_time' => ts('Activity Date-Time'), |
| 59 | ), |
| 60 | CRM_Utils_Token::getCustomFieldTokens('Activity') |
| 61 | )); |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * @inheritDoc |
| 66 | */ |
| 67 | public function checkActive(\Civi\Token\TokenProcessor $processor) { |
| 68 | // Extracted from scheduled-reminders code. See the class description. |
| 69 | return |
| 70 | !empty($processor->context['actionMapping']) |
| 71 | && $processor->context['actionMapping']->getEntity() === 'civicrm_activity'; |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * @inheritDoc |
| 76 | */ |
| 77 | public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQueryEvent $e) { |
| 78 | if ($e->mapping->getEntity() !== 'civicrm_activity') { |
| 79 | return; |
| 80 | } |
| 81 | |
| 82 | // The joint expression for activities needs some extra nuance to handle. |
| 83 | // Multiple revisions of the activity. |
| 84 | // Q: Could we simplify & move the extra AND clauses into `where(...)`? |
| 85 | $e->query->param('casEntityJoinExpr', 'e.id = reminder.entity_id AND e.is_current_revision = 1 AND e.is_deleted = 0'); |
| 86 | |
| 87 | $e->query->select('e.*'); // FIXME: seems too broad. |
| 88 | $e->query->select('ov.label as activity_type, e.id as activity_id'); |
| 89 | |
| 90 | $e->query->join("og", "!casMailingJoinType civicrm_option_group og ON og.name = 'activity_type'"); |
| 91 | $e->query->join("ov", "!casMailingJoinType civicrm_option_value ov ON e.activity_type_id = ov.value AND ov.option_group_id = og.id"); |
| 92 | |
| 93 | // if CiviCase component is enabled, join for caseId. |
| 94 | $compInfo = CRM_Core_Component::getEnabledComponents(); |
| 95 | if (array_key_exists('CiviCase', $compInfo)) { |
| 96 | $e->query->select("civicrm_case_activity.case_id as case_id"); |
| 97 | $e->query->join('civicrm_case_activity', "LEFT JOIN `civicrm_case_activity` ON `e`.`id` = `civicrm_case_activity`.`activity_id`"); |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * @inheritDoc |
| 103 | */ |
| 104 | public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) { |
| 105 | $actionSearchResult = $row->context['actionSearchResult']; |
| 106 | |
| 107 | if (in_array($field, array('activity_date_time'))) { |
| 108 | $row->tokens($entity, $field, \CRM_Utils_Date::customFormat($actionSearchResult->$field)); |
| 109 | } |
| 110 | elseif (isset($actionSearchResult->$field)) { |
| 111 | $row->tokens($entity, $field, $actionSearchResult->$field); |
| 112 | } |
| 113 | elseif ($cfID = \CRM_Core_BAO_CustomField::getKeyID($field)) { |
| 114 | $row->customToken($entity, $cfID, $actionSearchResult->entity_id); |
| 115 | } |
| 116 | else { |
| 117 | $row->tokens($entity, $field, ''); |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | } |