Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
731a0992 | 6 | | CiviCRM version 4.5 | |
6a488035 | 7 | +--------------------------------------------------------------------+ |
731a0992 | 8 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
9 | +--------------------------------------------------------------------+ |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
13 | | under the terms of the GNU Affero General Public License | | |
14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
15 | | | | |
16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
19 | | See the GNU Affero General Public License for more details. | | |
20 | | | | |
21 | | You should have received a copy of the GNU Affero General Public | | |
22 | | License and the CiviCRM Licensing Exception along | | |
23 | | with this program; if not, contact CiviCRM LLC | | |
24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
27 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 group contact functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Group | |
35 | * | |
731a0992 | 36 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
37 | * @version $Id: GroupContact.php 30171 2010-10-14 09:11:27Z mover $ |
38 | * | |
39 | */ | |
40 | ||
41 | ||
42 | /** | |
43 | * This API will give list of the groups for particular contact | |
c206647d | 44 | * Particular status can be sent in params array |
6a488035 TO |
45 | * If no status mentioned in params, by default 'added' will be used |
46 | * to fetch the records | |
47 | * | |
48 | * @param array $params name value pair of contact information | |
49 | * {@getfields GroupContact_get} | |
50 | * | |
51 | * @return array list of groups, given contact subsribed to | |
52 | */ | |
53 | function civicrm_api3_group_contact_get($params) { | |
54 | ||
55 | if (empty($params['contact_id'])) { | |
56 | if (empty($params['status'])) { | |
57 | //default to 'Added' | |
58 | $params['status'] = 'Added'; | |
59 | } | |
60 | //ie. id passed in so we have to return something | |
3d700d00 | 61 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 TO |
62 | } |
63 | $status = CRM_Utils_Array::value('status', $params, 'Added'); | |
64 | ||
65 | $values = &CRM_Contact_BAO_GroupContact::getContactGroup($params['contact_id'], $status, NULL, FALSE, TRUE); | |
66 | return civicrm_api3_create_success($values, $params); | |
67 | } | |
68 | ||
69 | /** | |
70 | * Add contact(s) to group(s) | |
71 | * | |
72 | * @access public | |
73 | * | |
74 | * @param array $params Input parameters | |
75 | * | |
76 | * Allowed @params array keys are:<br> | |
77 | * "contact_id" (required) : first contact to add<br> | |
78 | * "group_id" (required): first group to add contact(s) to<br> | |
79 | * "contact_id.1" etc. (optional) : another contact to add<br> | |
80 | * "group_id.1" etc. (optional) : additional group to add contact(s) to<br> | |
81 | * "status" (optional) : one of "Added", "Pending" or "Removed" (default is "Added") | |
82 | * {@example GroupContactCreate.php 0} | |
83 | * | |
84 | * @return array Information about operation results | |
85 | * | |
86 | * On success, the return array will be structured as follows: | |
87 | * <code>array( | |
88 | * "is_error" => 0, | |
89 | * "version" => 3, | |
90 | * "count" => 3, | |
91 | * "values" => array( | |
92 | * "not_added" => integer, | |
93 | * "added" => integer, | |
94 | * "total_count" => integer | |
95 | * ) | |
96 | * )</code> | |
97 | * | |
98 | * On failure, the return array will be structured as follows: | |
99 | * <code>array( | |
100 | * 'is_error' => 1, | |
101 | * 'error_message' = string, | |
102 | * 'error_data' = mixed or undefined | |
103 | * )</code> | |
104 | * {@getfields GroupContact_create} | |
105 | */ | |
106 | function civicrm_api3_group_contact_create($params) { | |
3d700d00 CW |
107 | // Nonstandard bao - doesn't accept ID as a param, so convert id to group_id + contact_id |
108 | if (!empty($params['id'])) { | |
109 | $getParams = array('id' => $params['id']); | |
110 | $info = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $getParams); | |
111 | if (!empty($info['values'][$params['id']])) { | |
112 | $params['group_id'] = $info['values'][$params['id']]['group_id']; | |
113 | $params['contact_id'] = $info['values'][$params['id']]['contact_id']; | |
114 | } | |
115 | } | |
116 | civicrm_api3_verify_mandatory($params, NULL, array('group_id', 'contact_id')); | |
6a488035 TO |
117 | $action = CRM_Utils_Array::value('status', $params, 'Added'); |
118 | return _civicrm_api3_group_contact_common($params, $action); | |
119 | } | |
11e09c59 | 120 | |
6a488035 TO |
121 | /** |
122 | * | |
123 | * @param <type> $params | |
124 | * | |
77b97be7 | 125 | * @return array <type>@deprecated |
6a488035 TO |
126 | */ |
127 | function civicrm_api3_group_contact_delete($params) { | |
3d700d00 CW |
128 | $params['status'] = CRM_Utils_Array::value('status', $params, empty($params['skip_undelete']) ? 'Removed' : 'Deleted'); |
129 | // "Deleted" isn't a real option so skip the api wrapper to avoid pseudoconstant validation | |
130 | return civicrm_api3_group_contact_create($params); | |
6a488035 | 131 | } |
11e09c59 TO |
132 | |
133 | /** | |
6a488035 TO |
134 | * modify metadata |
135 | */ | |
136 | function _civicrm_api3_group_contact_delete_spec(&$params) { | |
137 | // set as not required no either/or std yet | |
138 | $params['id']['api.required'] = 0; | |
139 | } | |
140 | ||
141 | /** | |
142 | * | |
143 | * @param <type> $params | |
144 | * | |
77b97be7 | 145 | * @return array|int <type>@deprecated |
6a488035 TO |
146 | */ |
147 | function civicrm_api3_group_contact_pending($params) { | |
148 | $params['status'] = 'Pending'; | |
149 | return civicrm_api('GroupContact', 'Create', $params); | |
150 | } | |
151 | ||
152 | /** | |
153 | * | |
154 | * @param array $params | |
155 | * @param string $op | |
156 | * | |
157 | * @return Array | |
2ede60ec | 158 | * @todo behaviour is highly non-standard - need to figure out how to make this 'behave' |
6a488035 TO |
159 | * & at the very least return IDs & details of the groups created / changed |
160 | */ | |
161 | function _civicrm_api3_group_contact_common($params, $op = 'Added') { | |
162 | ||
163 | $contactIDs = array(); | |
164 | $groupIDs = array(); | |
165 | foreach ($params as $n => $v) { | |
166 | if (substr($n, 0, 10) == 'contact_id') { | |
167 | $contactIDs[] = $v; | |
168 | } | |
169 | elseif (substr($n, 0, 8) == 'group_id') { | |
170 | $groupIDs[] = $v; | |
171 | } | |
172 | } | |
173 | ||
174 | if (empty($contactIDs)) { | |
175 | return civicrm_api3_create_error('contact_id is a required field'); | |
176 | } | |
177 | ||
178 | if (empty($groupIDs)) { | |
179 | return civicrm_api3_create_error('group_id is a required field'); | |
180 | } | |
181 | ||
182 | $method = CRM_Utils_Array::value('method', $params, 'API'); | |
183 | $status = CRM_Utils_Array::value('status', $params, $op); | |
184 | $tracking = CRM_Utils_Array::value('tracking', $params); | |
6a488035 TO |
185 | |
186 | if ($op == 'Added' || $op == 'Pending') { | |
187 | $extraReturnValues= array( | |
188 | 'total_count' => 0, | |
189 | 'added' => 0, | |
190 | 'not_added' => 0 | |
191 | ); | |
192 | foreach ($groupIDs as $groupID) { | |
193 | list($tc, $a, $na) = CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIDs, | |
194 | $groupID, | |
195 | $method, | |
196 | $status, | |
197 | $tracking | |
198 | ); | |
199 | $extraReturnValues['total_count'] += $tc; | |
200 | $extraReturnValues['added'] += $a; | |
201 | $extraReturnValues['not_added'] += $na; | |
202 | } | |
203 | } | |
204 | else { | |
205 | $extraReturnValues= array( | |
206 | 'total_count' => 0, | |
207 | 'removed' => 0, | |
208 | 'not_removed' => 0 | |
209 | ); | |
210 | foreach ($groupIDs as $groupID) { | |
211 | list($tc, $r, $nr) = CRM_Contact_BAO_GroupContact::removeContactsFromGroup($contactIDs, $groupID, $method, $status, $tracking); | |
212 | $extraReturnValues['total_count'] += $tc; | |
213 | $extraReturnValues['removed'] += $r; | |
214 | $extraReturnValues['not_removed'] += $nr; | |
215 | } | |
216 | } | |
217 | $dao = null;// can't pass this by reference | |
218 | return civicrm_api3_create_success(1,$params,'group_contact','create',$dao,$extraReturnValues); | |
219 | } | |
11e09c59 TO |
220 | |
221 | /** | |
6a488035 TO |
222 | * @deprecated - this should be part of create but need to know we aren't missing something |
223 | */ | |
224 | function civicrm_api3_group_contact_update_status($params) { | |
225 | ||
226 | civicrm_api3_verify_mandatory($params, NULL, array('contact_id', 'group_id')); | |
227 | ||
c49a2977 CW |
228 | CRM_Contact_BAO_GroupContact::addContactsToGroup( |
229 | array($params['contact_id']), | |
230 | $params['group_id'], | |
231 | CRM_Utils_Array::value('method', $params, 'API'), | |
232 | 'Added', | |
233 | CRM_Utils_Array::value('tracking', $params) | |
234 | ); | |
6a488035 TO |
235 | |
236 | return TRUE; | |
237 | } | |
238 | ||
a14e9d08 CW |
239 | /** |
240 | * @deprecated api notice | |
241 | * @return array of deprecated actions | |
242 | */ | |
243 | function _civicrm_api3_group_contact_deprecation() { | |
244 | return array( | |
245 | 'delete' => 'GroupContact "delete" action is deprecated in favor of "create".', | |
246 | 'pending' => 'GroupContact "pending" action is deprecated in favor of "create".', | |
247 | 'update_status' => 'GroupContact "update_status" action is deprecated in favor of "create".', | |
248 | ); | |
249 | } | |
250 |