projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 6a488035 TO |
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 | * @todo convert to using basic create - BAO function non-std | |
| 46 | */ | |
| 47 | function civicrm_api3_im_create($params) { | |
| 48 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 49 | ||
| 50 | } | |
| 11e09c59 TO |
51 | |
| 52 | /** | |
| 6a488035 TO |
53 | * Adjust Metadata for Create action |
| 54 | * | |
| 55 | * The metadata is used for setting defaults, documentation & validation | |
| 56 | * @param array $params array or parameters determined by getfields | |
| 57 | */ | |
| 58 | function _civicrm_api3_im_create_spec(&$params) { | |
| 59 | $params['contact_id']['api.required'] = 1; | |
| 60 | } | |
| 61 | ||
| 62 | /** | |
| 63 | * Deletes an existing IM | |
| 64 | * | |
| 65 | * @param array $params | |
| 66 | * {@getfields im_delete} | |
| 67 | * | |
| 68 | * @return array API result Array | |
| 69 | * @access public | |
| 70 | * @todo convert to using Basic delete - BAO function non standard | |
| 71 | */ | |
| 72 | function civicrm_api3_im_delete($params) { | |
| 73 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 74 | } | |
| 75 | ||
| 76 | /** | |
| 77 | * Retrieve one or more IM | |
| 78 | * | |
| 79 | * @param mixed[] (reference ) input parameters | |
| 80 | * {@getfields im_get} | |
| 81 | * @param array $params an associative array of name/value pairs. | |
| 82 | * | |
| 83 | * @return array details of found IM | |
| 84 | * | |
| 85 | * @access public | |
| 86 | */ | |
| 87 | function civicrm_api3_im_get($params) { | |
| 88 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 89 | } | |
| 90 |