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 | /** | |
39 | * Add a record relating a contact with an activity | |
40 | * | |
41 | * Allowed @params array keys are: | |
42 | * | |
43 | * @example ActivityContact.php | |
44 | * | |
c490a46a | 45 | * @param array $params |
77b97be7 | 46 | * |
a6c01b45 | 47 | * @return array |
16b10e64 | 48 | * Array of newly created activity contact records. |
3ed73cde | 49 | */ |
50 | function civicrm_api3_activity_contact_create($params) { | |
51 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
52 | } | |
53 | ||
54 | /** | |
55 | * Adjust Metadata for Create action | |
56 | * | |
57 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
58 | * @param array $params |
59 | * Array or parameters determined by getfields. | |
3ed73cde | 60 | */ |
61 | function _civicrm_api3_activity_contact_create_spec(&$params) { | |
62 | $params['contact_id']['api.required'] = 1; | |
63 | $params['activity_id']['api.required'] = 1; | |
64 | } | |
65 | ||
66 | /** | |
67 | * Deletes an existing ActivityContact record | |
68 | * | |
cf470720 | 69 | * @param array $params |
3ed73cde | 70 | * |
a6c01b45 | 71 | * @return array |
72b3a70c | 72 | * Api Result |
77b97be7 | 73 | * |
3ed73cde | 74 | * @example ActivityContact.php |
3ed73cde | 75 | */ |
76 | function civicrm_api3_activity_contact_delete($params) { | |
77 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
78 | } | |
79 | ||
80 | /** | |
81 | * Get a ActivityContact. | |
82 | * | |
83 | * @example ActivityContact.php | |
84 | * | |
cf470720 TO |
85 | * @param array $params |
86 | * An associative array of name/value pairs. | |
3ed73cde | 87 | * |
a6c01b45 | 88 | * @return array |
72b3a70c | 89 | * details of found tags else error |
3ed73cde | 90 | * |
3ed73cde | 91 | */ |
92 | function civicrm_api3_activity_contact_get($params) { | |
93 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
94 | } |