Commit | Line | Data |
---|---|---|
2ede60ec DL |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
2ede60ec | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
2ede60ec DL |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM contact and mailing. |
2ede60ec DL |
30 | * |
31 | * @package CiviCRM_APIv3 | |
2ede60ec DL |
32 | */ |
33 | ||
34 | /** | |
9d32e6f7 | 35 | * Get all the mailings and details that a contact was involved with. |
2ede60ec | 36 | * |
cf470720 | 37 | * @param array $params |
02ac46aa | 38 | * Input parameters - see _spec for details (returned by getfields) |
2ede60ec | 39 | * |
a6c01b45 | 40 | * @return array |
72b3a70c | 41 | * API result |
2ede60ec DL |
42 | */ |
43 | function civicrm_api3_mailing_contact_get($params) { | |
b14ce773 | 44 | return civicrm_api3_create_success(_civicrm_api3_mailing_contact_getresults($params, FALSE)); |
45 | } | |
244bbdd8 | 46 | |
b14ce773 | 47 | /** |
9d32e6f7 EM |
48 | * This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact. |
49 | * | |
b14ce773 | 50 | * @param array $params |
cf470720 | 51 | * @param bool $count |
9d32e6f7 | 52 | * |
b14ce773 | 53 | * @throws Exception |
54 | */ | |
9b873358 TO |
55 | function _civicrm_api3_mailing_contact_getresults($params, $count) { |
56 | if (empty($params['type'])) { | |
02ac46aa | 57 | //ie. because the api is an anomaly & passing in id is not valid |
b14ce773 | 58 | throw new Exception('This api call does not accept api as a parameter'); |
2ede60ec | 59 | } |
28a04ea9 | 60 | $options = _civicrm_api3_get_options_from_params($params, TRUE, 'contribution', 'get'); |
2ede60ec DL |
61 | $fnName = '_civicrm_api3_mailing_contact_get_' . strtolower($params['type']); |
62 | return $fnName( | |
b14ce773 | 63 | $params['contact_id'], |
64 | $options['offset'], | |
65 | $options['limit'], | |
66 | $options['sort'], | |
67 | $count | |
68 | ); | |
69 | } | |
9d32e6f7 | 70 | |
b14ce773 | 71 | /** |
9d32e6f7 | 72 | * Adjust Metadata for Get action. |
b14ce773 | 73 | * |
cf470720 | 74 | * @param array $params |
b081365f | 75 | * Array of parameters determined by getfields. |
b14ce773 | 76 | */ |
77 | function _civicrm_api3_mailing_contact_get_spec(&$params) { | |
78 | $params['contact_id']['api.required'] = 1; | |
4c41ecb2 | 79 | $params['contact_id']['title'] = 'Contact ID'; |
b14ce773 | 80 | $params['type'] = array( |
81 | 'api.default' => 'Delivered', | |
28a04ea9 | 82 | 'title' => 'Type', // doesn't really explain the field - but not sure I understand it to explain it better |
b14ce773 | 83 | 'type' => CRM_Utils_Type::T_STRING, |
84 | 'options' => array( | |
85 | 'Delivered' => 'Delivered', | |
86 | 'Bounced' => 'Bounced', | |
21dfd5f5 | 87 | ), |
2ede60ec DL |
88 | ); |
89 | } | |
90 | ||
aa1b1481 | 91 | /** |
9d32e6f7 EM |
92 | * Helper function for mailing contact queries. |
93 | * | |
100fef9d | 94 | * @param int $contactID |
aa1b1481 EM |
95 | * @param $offset |
96 | * @param $limit | |
97 | * @param $selectFields | |
98 | * @param $fromClause | |
99 | * @param $whereClause | |
100 | * @param $sort | |
101 | * @param $getCount | |
102 | * | |
103 | * @return array | |
104 | */ | |
2ede60ec | 105 | function _civicrm_api3_mailing_contact_query( |
2ede60ec DL |
106 | $contactID, |
107 | $offset, | |
108 | $limit, | |
109 | $selectFields, | |
110 | $fromClause, | |
100afa30 | 111 | $whereClause, |
a6fe948b KJ |
112 | $sort, |
113 | $getCount | |
2ede60ec | 114 | ) { |
2ede60ec | 115 | |
a6fe948b KJ |
116 | if ($getCount) { |
117 | $sql = " | |
118 | SELECT count(*) | |
119 | FROM civicrm_mailing m | |
120 | INNER JOIN civicrm_contact c ON m.created_id = c.id | |
121 | INNER JOIN civicrm_mailing_job j ON j.mailing_id = m.id | |
122 | INNER JOIN civicrm_mailing_event_queue meq ON meq.job_id = j.id | |
123 | $fromClause | |
124 | WHERE j.is_test = 0 | |
125 | AND meq.contact_id = %1 | |
126 | $whereClause | |
127 | GROUP BY m.id | |
128 | "; | |
129 | ||
130 | $qParams = array( | |
21dfd5f5 | 131 | 1 => array($contactID, 'Integer'), |
a6fe948b KJ |
132 | ); |
133 | $dao = CRM_Core_DAO::executeQuery($sql, $qParams); | |
134 | ||
b14ce773 | 135 | $results = $dao->N; |
2ede60ec DL |
136 | } |
137 | else { | |
a6fe948b KJ |
138 | $defaultFields = array( |
139 | 'm.id' => 'mailing_id', | |
140 | 'm.subject' => 'subject', | |
141 | 'c.id' => 'creator_id', | |
142 | 'c.sort_name' => 'creator_name', | |
143 | ); | |
2ede60ec | 144 | |
a6fe948b KJ |
145 | if ($selectFields) { |
146 | $fields = array_merge($selectFields, $defaultFields); | |
147 | } | |
148 | else { | |
149 | $fields = $defaultFields; | |
150 | } | |
2ede60ec | 151 | |
a6fe948b KJ |
152 | $select = array(); |
153 | foreach ($fields as $n => $l) { | |
154 | $select[] = "$n as $l"; | |
155 | } | |
156 | $select = implode(', ', $select); | |
157 | ||
0f0855d8 | 158 | $orderBy = 'ORDER BY j.start_date DESC'; |
a6fe948b KJ |
159 | if ($sort) { |
160 | $orderBy = "ORDER BY $sort"; | |
161 | } | |
100afa30 | 162 | |
a6fe948b | 163 | $sql = " |
2ede60ec DL |
164 | SELECT $select |
165 | FROM civicrm_mailing m | |
166 | INNER JOIN civicrm_contact c ON m.created_id = c.id | |
167 | INNER JOIN civicrm_mailing_job j ON j.mailing_id = m.id | |
168 | INNER JOIN civicrm_mailing_event_queue meq ON meq.job_id = j.id | |
169 | $fromClause | |
170 | WHERE j.is_test = 0 | |
171 | AND meq.contact_id = %1 | |
172 | $whereClause | |
173 | GROUP BY m.id | |
100afa30 | 174 | {$orderBy} |
2ede60ec DL |
175 | "; |
176 | ||
a6fe948b KJ |
177 | if ($limit > 0) { |
178 | $sql .= " | |
2ede60ec DL |
179 | LIMIT %2, %3 |
180 | "; | |
a6fe948b | 181 | } |
2ede60ec | 182 | |
a6fe948b KJ |
183 | $qParams = array( |
184 | 1 => array($contactID, 'Integer'), | |
185 | 2 => array($offset, 'Integer'), | |
21dfd5f5 | 186 | 3 => array($limit, 'Integer'), |
a6fe948b KJ |
187 | ); |
188 | $dao = CRM_Core_DAO::executeQuery($sql, $qParams); | |
2ede60ec | 189 | |
a6fe948b KJ |
190 | $results = array(); |
191 | while ($dao->fetch()) { | |
192 | foreach ($fields as $n => $l) { | |
193 | $results[$dao->mailing_id][$l] = $dao->$l; | |
194 | } | |
2ede60ec DL |
195 | } |
196 | } | |
197 | ||
b14ce773 | 198 | return $results; |
2ede60ec DL |
199 | } |
200 | ||
aa1b1481 | 201 | /** |
35823763 EM |
202 | * Get delivered mailing contacts. |
203 | * | |
100fef9d | 204 | * @param int $contactID |
aa1b1481 EM |
205 | * @param $offset |
206 | * @param $limit | |
207 | * @param $sort | |
208 | * @param $getCount | |
209 | * | |
210 | * @return array | |
211 | */ | |
2ede60ec DL |
212 | function _civicrm_api3_mailing_contact_get_delivered( |
213 | $contactID, | |
214 | $offset, | |
100afa30 | 215 | $limit, |
a6fe948b KJ |
216 | $sort, |
217 | $getCount | |
2ede60ec DL |
218 | ) { |
219 | $selectFields = array('med.time_stamp' => 'start_date'); | |
220 | ||
221 | $fromClause = " | |
222 | INNER JOIN civicrm_mailing_event_delivered med ON med.event_queue_id = meq.id | |
223 | LEFT JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id | |
224 | "; | |
225 | ||
226 | $whereClause = " | |
227 | AND meb.id IS NULL | |
228 | "; | |
229 | ||
230 | return _civicrm_api3_mailing_contact_query( | |
2ede60ec DL |
231 | $contactID, |
232 | $offset, | |
233 | $limit, | |
234 | $selectFields, | |
235 | $fromClause, | |
100afa30 | 236 | $whereClause, |
a6fe948b KJ |
237 | $sort, |
238 | $getCount | |
2ede60ec DL |
239 | ); |
240 | } | |
241 | ||
aa1b1481 | 242 | /** |
1747ab99 EM |
243 | * Get bounced mailing contact records. |
244 | * | |
100fef9d | 245 | * @param int $contactID |
aa1b1481 EM |
246 | * @param $offset |
247 | * @param $limit | |
248 | * @param $sort | |
249 | * @param $getCount | |
250 | * | |
251 | * @return array | |
252 | */ | |
2ede60ec DL |
253 | function _civicrm_api3_mailing_contact_get_bounced( |
254 | $contactID, | |
255 | $offset, | |
100afa30 | 256 | $limit, |
a6fe948b KJ |
257 | $sort, |
258 | $getCount | |
2ede60ec DL |
259 | ) { |
260 | $fromClause = " | |
261 | INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id | |
262 | "; | |
263 | ||
264 | return _civicrm_api3_mailing_contact_query( | |
2ede60ec DL |
265 | $contactID, |
266 | $offset, | |
267 | $limit, | |
268 | NULL, | |
269 | $fromClause, | |
100afa30 | 270 | NULL, |
a6fe948b KJ |
271 | $sort, |
272 | $getCount | |
2ede60ec DL |
273 | ); |
274 | } | |
a6fe948b KJ |
275 | |
276 | /** | |
d1b0d05e | 277 | * Get count of all the mailings that a contact was involved with. |
a6fe948b | 278 | * |
cf470720 | 279 | * @param array $params |
02ac46aa | 280 | * Input parameters per getfields |
a6fe948b | 281 | * |
a6c01b45 | 282 | * @return array |
72b3a70c | 283 | * API result |
a6fe948b KJ |
284 | */ |
285 | function civicrm_api3_mailing_contact_getcount($params) { | |
b14ce773 | 286 | return _civicrm_api3_mailing_contact_getresults($params, TRUE); |
a6fe948b | 287 | } |