Merge pull request #266 from colemanw/CRM-12229
[civicrm-core.git] / api / v3 / Im.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.2 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2012 |
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 *
34 * @copyright CiviCRM LLC (c) 2004-2013
35 */
36
37 /**
38 * Add an IM for a contact
39 *
40 * Allowed @params array keys are:
41 * {@getfields im_create}
42 *
43 * @return array of newly created IM property values.
44 * @access public
45 */
46 function civicrm_api3_im_create($params) {
47 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
48 }
49
50 /**
51 * Adjust Metadata for Create action
52 *
53 * The metadata is used for setting defaults, documentation & validation
54 * @param array $params array or parameters determined by getfields
55 */
56 function _civicrm_api3_im_create_spec(&$params) {
57 $params['contact_id']['api.required'] = 1;
58 }
59
60 /**
61 * Deletes an existing IM
62 *
63 * @param array $params
64 * {@getfields im_delete}
65 *
66 * @return array API result Array
67 * @access public
68 * @todo convert to using Basic delete - BAO function non standard
69 */
70 function civicrm_api3_im_delete($params) {
71 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
72 }
73
74 /**
75 * Retrieve one or more IM
76 *
77 * @param mixed[] (reference ) input parameters
78 * {@getfields im_get}
79 * @param array $params an associative array of name/value pairs.
80 *
81 * @return array details of found IM
82 *
83 * @access public
84 */
85 function civicrm_api3_im_get($params) {
86 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
87 }
88