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 | ||
a14e9d08 CW |
39 | /** |
40 | * @deprecated api notice | |
a6c01b45 | 41 | * @return string |
72b3a70c | 42 | * to indicate this entire api entity is deprecated |
a14e9d08 CW |
43 | */ |
44 | function _civicrm_api3_mailing_group_deprecation() { | |
45 | return 'The mailing_group api is deprecated. Use the mailing_event apis instead.'; | |
46 | } | |
47 | ||
6a488035 TO |
48 | /** |
49 | * Handle an unsubscribe event | |
50 | * @deprecated | |
51 | * | |
52 | * @param array $params | |
53 | * | |
54 | * @return array | |
55 | */ | |
56 | function civicrm_api3_mailing_group_event_unsubscribe($params) { | |
7e6e8bd6 | 57 | return civicrm_api('mailing_event_unsubscribe', 'create', $params); |
6a488035 TO |
58 | } |
59 | ||
60 | /** | |
61 | * Handle a site-level unsubscribe event | |
bafd17fb | 62 | * @deprecated |
6a488035 TO |
63 | * |
64 | * @param array $params | |
65 | * | |
66 | * @return array | |
67 | */ | |
68 | function civicrm_api3_mailing_group_event_domain_unsubscribe($params) { | |
7e6e8bd6 TO |
69 | $params['org_unsubscribe'] = 1; |
70 | return civicrm_api('mailing_event_unsubscribe', 'create', $params); | |
6a488035 TO |
71 | } |
72 | ||
73 | /** | |
74 | * Handle a resubscription event | |
75 | * @deprecated | |
76 | * | |
77 | * @param array $params | |
78 | * | |
79 | * @return array | |
80 | */ | |
81 | function civicrm_api3_mailing_group_event_resubscribe($params) { | |
7e6e8bd6 | 82 | return civicrm_api('mailing_event_resubscribe', 'create', $params); |
6a488035 TO |
83 | } |
84 | ||
85 | /** | |
86 | * Handle a subscription event | |
87 | * @deprecated | |
88 | * | |
89 | * @param array $params | |
90 | * | |
91 | * @return array | |
92 | */ | |
93 | function civicrm_api3_mailing_group_event_subscribe($params) { | |
7e6e8bd6 | 94 | return civicrm_api('mailing_event_subscribe', 'create', $params); |
6a488035 TO |
95 | } |
96 | ||
c23f45d3 EM |
97 | /** |
98 | * @param array $params | |
99 | * @return array | |
100 | * @throws \API_Exception | |
101 | */ | |
21eb0c57 TO |
102 | function civicrm_api3_mailing_group_create($params) { |
103 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
104 | } | |
105 | ||
aa1b1481 | 106 | /** |
c490a46a | 107 | * @param array $params |
aa1b1481 EM |
108 | * |
109 | * @return array | |
110 | */ | |
f27a0a8e | 111 | function civicrm_api3_mailing_group_get($params) { |
112 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
113 | } | |
114 | ||
c23f45d3 EM |
115 | /** |
116 | * @param array $params | |
117 | * @return array | |
118 | * @throws \API_Exception | |
119 | */ | |
120 | function civicrm_api3_mailing_group_delete($params) { | |
f27a0a8e | 121 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
122 | } | |
123 | ||
c23f45d3 EM |
124 | /** |
125 | * @param array $params | |
126 | * @return array | |
127 | */ | |
6a488035 | 128 | function civicrm_api3_mailing_group_getfields($params) { |
7e6e8bd6 TO |
129 | $dao = _civicrm_api3_get_DAO('Subscribe'); |
130 | $d = new $dao(); | |
131 | $fields = $d->fields(); | |
132 | $d->free(); | |
6a488035 | 133 | |
7e6e8bd6 TO |
134 | $dao = _civicrm_api3_get_DAO('Unsubscribe'); |
135 | $d = new $dao(); | |
136 | $fields = $fields + $d->fields(); | |
137 | $d->free(); | |
6a488035 | 138 | |
7e6e8bd6 TO |
139 | // CRM-13830 - prevent the api wrapper from helping out with pseudoconstants |
140 | // Since these fields don't belong to this entity it will fail | |
141 | foreach ($fields as &$field) { | |
142 | unset($field['pseudoconstant']); | |
143 | } | |
bafd17fb | 144 | |
77d80c9f | 145 | return civicrm_api3_create_success($fields, $params, 'mailing_group', 'getfields'); |
6a488035 | 146 | } |