Commit | Line | Data |
---|---|---|
3ed73cde | 1 | <?php |
3ed73cde | 2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
3ed73cde | 5 | +--------------------------------------------------------------------+ |
39de6fd5 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
3ed73cde | 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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
3ed73cde | 27 | |
28 | /** | |
29 | * File for the CiviCRM APIv3 activity contact functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_ActivityContact | |
33 | * | |
34 | * @copyright CiviCRM LLC (c) 2004-2014 | |
35 | * @version $Id: ActivityContact.php 2014-04-01 elcapo $ | |
36 | */ | |
37 | ||
38 | /** | |
dc64d047 | 39 | * Add a record relating a contact with an activity. |
3ed73cde | 40 | * |
c490a46a | 41 | * @param array $params |
77b97be7 | 42 | * |
a6c01b45 | 43 | * @return array |
1747ab99 | 44 | * API result array. |
3ed73cde | 45 | */ |
46 | function civicrm_api3_activity_contact_create($params) { | |
47 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
48 | } | |
49 | ||
50 | /** | |
0aa0303c EM |
51 | * Adjust Metadata for Create action. |
52 | * | |
53 | * The metadata is used for setting defaults, documentation & validation. | |
3ed73cde | 54 | * |
cf470720 TO |
55 | * @param array $params |
56 | * Array or parameters determined by getfields. | |
3ed73cde | 57 | */ |
58 | function _civicrm_api3_activity_contact_create_spec(&$params) { | |
59 | $params['contact_id']['api.required'] = 1; | |
60 | $params['activity_id']['api.required'] = 1; | |
61 | } | |
62 | ||
63 | /** | |
dc64d047 | 64 | * Delete an existing ActivityContact record. |
3ed73cde | 65 | * |
cf470720 | 66 | * @param array $params |
3ed73cde | 67 | * |
a6c01b45 | 68 | * @return array |
72b3a70c | 69 | * Api Result |
3ed73cde | 70 | */ |
71 | function civicrm_api3_activity_contact_delete($params) { | |
72 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
73 | } | |
74 | ||
75 | /** | |
76 | * Get a ActivityContact. | |
77 | * | |
cf470720 TO |
78 | * @param array $params |
79 | * An associative array of name/value pairs. | |
3ed73cde | 80 | * |
a6c01b45 | 81 | * @return array |
72b3a70c | 82 | * details of found tags else error |
3ed73cde | 83 | */ |
84 | function civicrm_api3_activity_contact_get($params) { | |
85 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
86 | } |