Commit | Line | Data |
---|---|---|
46f5566c TO |
1 | <?php |
2 | ||
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
3435af9a | 5 | | CiviCRM version 4.7 | |
46f5566c TO |
6 | +--------------------------------------------------------------------+ |
7 | | Copyright CiviCRM LLC (c) 2004-2015 | | |
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 | * Class CRM_Event_Tokens | |
31 | * | |
32 | * Generate "event.*" tokens. | |
33 | * | |
34 | * This TokenSubscriber was produced by refactoring the code from the | |
35 | * scheduled-reminder system with the goal of making that system | |
36 | * more flexible. The current implementation is still coupled to | |
37 | * scheduled-reminders. It would be good to figure out a more generic | |
38 | * implementation which is not tied to scheduled reminders, although | |
39 | * that is outside the current scope. | |
40 | */ | |
41 | class CRM_Event_Tokens extends \Civi\Token\AbstractTokenSubscriber { | |
42 | ||
70599df6 | 43 | /** |
44 | * Class constructor. | |
45 | */ | |
46f5566c TO |
46 | public function __construct() { |
47 | parent::__construct('event', array( | |
48 | 'event_type' => ts('Event Type'), | |
49 | 'title' => ts('Event Title'), | |
50 | 'event_id' => ts('Event ID'), | |
51 | 'start_date' => ts('Event Start Date'), | |
52 | 'end_date' => ts('Event End Date'), | |
53 | 'summary' => ts('Event Summary'), | |
54 | 'description' => ts('Event Description'), | |
55 | 'location' => ts('Event Location'), | |
56 | 'info_url' => ts('Event Info URL'), | |
57 | 'registration_url' => ts('Event Registration URL'), | |
58 | 'fee_amount' => ts('Event Fee'), | |
59 | 'contact_email' => ts('Event Contact (Email)'), | |
60 | 'contact_phone' => ts('Event Contact (Phone)'), | |
61 | 'balance' => ts('Event Balance'), | |
62 | )); | |
63 | } | |
64 | ||
70599df6 | 65 | /** |
66 | * Check something about being active. | |
67 | * | |
68 | * @param \Civi\Token\TokenProcessor $processor | |
69 | * | |
70 | * @return bool | |
71 | */ | |
46f5566c TO |
72 | public function checkActive(\Civi\Token\TokenProcessor $processor) { |
73 | // Extracted from scheduled-reminders code. See the class description. | |
74 | return | |
75 | !empty($processor->context['actionMapping']) | |
76 | && $processor->context['actionMapping']->getEntity() === 'civicrm_participant'; | |
77 | } | |
78 | ||
f9ec2da6 TO |
79 | public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQueryEvent $e) { |
80 | if ($e->mapping->getEntity() !== 'civicrm_participant') { | |
81 | return; | |
82 | } | |
83 | ||
84 | $e->query->select('e.*'); // FIXME: seems too broad. | |
85 | $e->query->select('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'); | |
86 | $e->query->join('participant_stuff', " | |
87 | !casMailingJoinType civicrm_event ev ON e.event_id = ev.id | |
88 | !casMailingJoinType civicrm_option_group og ON og.name = 'event_type' | |
89 | !casMailingJoinType civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id | |
90 | LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id | |
91 | LEFT JOIN civicrm_address address ON address.id = lb.address_id | |
92 | LEFT JOIN civicrm_email email ON email.id = lb.email_id | |
93 | LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id | |
94 | "); | |
95 | } | |
96 | ||
46f5566c TO |
97 | /** |
98 | * Evaluate the content of a single token. | |
99 | * | |
100 | * @param \Civi\Token\TokenRow $row | |
101 | * The record for which we want token values. | |
ad37ac8e | 102 | * @param string $entity |
46f5566c TO |
103 | * @param string $field |
104 | * The name of the token field. | |
105 | * @param mixed $prefetch | |
106 | * Any data that was returned by the prefetch(). | |
ad37ac8e | 107 | * |
46f5566c TO |
108 | * @return mixed |
109 | */ | |
110 | public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) { | |
111 | $actionSearchResult = $row->context['actionSearchResult']; | |
112 | ||
113 | if ($field == 'location') { | |
114 | $loc = array(); | |
115 | $stateProvince = \CRM_Core_PseudoConstant::stateProvince(); | |
116 | $loc['street_address'] = $actionSearchResult->street_address; | |
117 | $loc['city'] = $actionSearchResult->city; | |
118 | $loc['state_province'] = \CRM_Utils_Array::value($actionSearchResult->state_province_id, $stateProvince); | |
119 | $loc['postal_code'] = $actionSearchResult->postal_code; | |
120 | //$entityTokenParams[$tokenEntity][$field] = \CRM_Utils_Address::format($loc); | |
121 | $row->tokens($entity, $field, \CRM_Utils_Address::format($loc)); | |
122 | } | |
123 | elseif ($field == 'info_url') { | |
124 | $row | |
125 | ->tokens($entity, $field, \CRM_Utils_System::url('civicrm/event/info', 'reset=1&id=' . $actionSearchResult->event_id, TRUE, NULL, FALSE)); | |
126 | } | |
127 | elseif ($field == 'registration_url') { | |
128 | $row | |
129 | ->tokens($entity, $field, \CRM_Utils_System::url('civicrm/event/register', 'reset=1&id=' . $actionSearchResult->event_id, TRUE, NULL, FALSE)); | |
130 | } | |
131 | elseif (in_array($field, array('start_date', 'end_date'))) { | |
132 | $row->tokens($entity, $field, \CRM_Utils_Date::customFormat($actionSearchResult->$field)); | |
133 | } | |
134 | elseif ($field == 'balance') { | |
135 | if ($actionSearchResult->entityTable == 'civicrm_contact') { | |
136 | $balancePay = 'N/A'; | |
137 | } | |
138 | elseif (!empty($actionSearchResult->entityID)) { | |
139 | $info = \CRM_Contribute_BAO_Contribution::getPaymentInfo($actionSearchResult->entityID, 'event'); | |
140 | $balancePay = \CRM_Utils_Array::value('balance', $info); | |
141 | $balancePay = \CRM_Utils_Money::format($balancePay); | |
142 | } | |
143 | $row->tokens($entity, $field, $balancePay); | |
144 | } | |
145 | elseif ($field == 'fee_amount') { | |
146 | $row->tokens($entity, $field, \CRM_Utils_Money::format($actionSearchResult->$field)); | |
147 | } | |
148 | elseif (isset($actionSearchResult->$field)) { | |
149 | $row->tokens($entity, $field, $actionSearchResult->$field); | |
150 | } | |
151 | else { | |
152 | $row->tokens($entity, $field, ''); | |
153 | } | |
154 | } | |
155 | ||
156 | } |