Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
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 | * File for the CiviCRM APIv3 IM functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_IM | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | */ |
36 | ||
37 | /** | |
38 | * Add an IM for a contact | |
39 | * | |
40 | * Allowed @params array keys are: | |
41 | * {@getfields im_create} | |
42 | * | |
c490a46a | 43 | * @param array $params |
77b97be7 | 44 | * |
a6c01b45 CW |
45 | * @return array |
46 | * of newly created IM property values. | |
6a488035 | 47 | * @access public |
6a488035 TO |
48 | */ |
49 | function civicrm_api3_im_create($params) { | |
50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
6a488035 | 51 | } |
11e09c59 TO |
52 | |
53 | /** | |
6a488035 TO |
54 | * Adjust Metadata for Create action |
55 | * | |
56 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
57 | * @param array $params |
58 | * Array or parameters determined by getfields. | |
6a488035 TO |
59 | */ |
60 | function _civicrm_api3_im_create_spec(&$params) { | |
61 | $params['contact_id']['api.required'] = 1; | |
62 | } | |
63 | ||
64 | /** | |
65 | * Deletes an existing IM | |
66 | * | |
cf470720 | 67 | * @param array $params |
6a488035 TO |
68 | * {@getfields im_delete} |
69 | * | |
a6c01b45 CW |
70 | * @return array |
71 | * API result Array | |
6a488035 TO |
72 | * @access public |
73 | * @todo convert to using Basic delete - BAO function non standard | |
74 | */ | |
75 | function civicrm_api3_im_delete($params) { | |
76 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
77 | } | |
78 | ||
79 | /** | |
80 | * Retrieve one or more IM | |
81 | * | |
cf470720 | 82 | * @param mixed[] (reference ) input parameters |
6a488035 | 83 | * {@getfields im_get} |
cf470720 TO |
84 | * @param array $params |
85 | * An associative array of name/value pairs. | |
6a488035 | 86 | * |
a6c01b45 CW |
87 | * @return array |
88 | * details of found IM | |
6a488035 TO |
89 | * |
90 | * @access public | |
91 | */ | |
92 | function civicrm_api3_im_get($params) { | |
93 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
94 | } |