Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | /** | |
29 | * | |
30 | * APIv3 functions for registering/processing mailing group events. | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_MailerGroup | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | ||
39 | /** | |
40 | * Subscribe from mailing group | |
41 | * | |
cf470720 TO |
42 | * @param array $params |
43 | * Associative array of property. | |
6a488035 TO |
44 | * name/value pairs to insert in new 'survey' |
45 | * | |
a6c01b45 | 46 | * @return array |
72b3a70c | 47 | * api result array |
6a488035 | 48 | * {@getfields mailing_event_subscribe_create} |
6a488035 TO |
49 | */ |
50 | function civicrm_api3_mailing_event_resubscribe_create($params) { | |
51 | ||
52 | $groups = CRM_Mailing_Event_BAO_Resubscribe::resub_to_mailing( | |
53 | $params['job_id'], | |
54 | $params['event_queue_id'], | |
55 | $params['hash'] | |
56 | ); | |
57 | ||
58 | if (count($groups)) { | |
59 | CRM_Mailing_Event_BAO_Resubscribe::send_resub_response( | |
60 | $params['event_queue_id'], | |
61 | $groups, FALSE, | |
62 | $params['job_id'] | |
63 | ); | |
64 | return civicrm_api3_create_success($params); | |
65 | } | |
66 | return civicrm_api3_create_error('Queue event could not be found'); | |
67 | } | |
11e09c59 TO |
68 | |
69 | /** | |
6a488035 | 70 | * Adjust Metadata for Create action |
1c88e578 | 71 | * |
6a488035 | 72 | * The metadata is used for setting defaults, documentation & validation |
cf470720 TO |
73 | * @param array $params |
74 | * Array or parameters determined by getfields. | |
6a488035 TO |
75 | */ |
76 | function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) { | |
77 | $params['event_queue_id']['api.required'] = 1; | |
a6aeb992 | 78 | $params['event_queue_id']['title'] = 'Event Queue ID'; |
6a488035 | 79 | $params['job_id']['api.required'] = 1; |
a6aeb992 | 80 | $params['job_id']['title'] = 'Job ID'; |
6a488035 | 81 | $params['hash']['api.required'] = 1; |
a6aeb992 | 82 | $params['hash']['title'] = 'Hash'; |
6a488035 | 83 | } |