projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 6a488035 TO |
1 | <?php |
| 2 | // $Id$ | |
| 3 | ||
| 4 | /* | |
| 5 | +--------------------------------------------------------------------+ | |
| 6 | | CiviCRM version 4.3 | | |
| 7 | +--------------------------------------------------------------------+ | |
| 8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
| 9 | +--------------------------------------------------------------------+ | |
| 10 | | This file is a part of CiviCRM. | | |
| 11 | | | | |
| 12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
| 13 | | under the terms of the GNU Affero General Public License | | |
| 14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
| 15 | | | | |
| 16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
| 17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
| 18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
| 19 | | See the GNU Affero General Public License for more details. | | |
| 20 | | | | |
| 21 | | You should have received a copy of the GNU Affero General Public | | |
| 22 | | License and the CiviCRM Licensing Exception along | | |
| 23 | | with this program; if not, contact CiviCRM LLC | | |
| 24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
| 25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
| 26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
| 27 | +--------------------------------------------------------------------+ | |
| 28 | */ | |
| 29 | ||
| 30 | /** | |
| 31 | * File for the CiviCRM APIv3 phone functions | |
| 32 | * | |
| 33 | * @package CiviCRM_APIv3 | |
| 34 | * @subpackage API_Phone | |
| 35 | * | |
| 36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
| 37 | * @version $Id: Phone.php 2011-03-16 ErikHommel $ | |
| 38 | */ | |
| 39 | ||
| 6a488035 TO |
40 | /** |
| 41 | * Add an Phone for a contact | |
| 42 | * | |
| 43 | * Allowed @params array keys are: | |
| 44 | * {@getfields phone_create} | |
| 45 | * @example PhoneCreate.php | |
| 46 | * | |
| 47 | * @return array of newly created phone property values. | |
| 48 | * @access public | |
| 49 | */ | |
| 50 | function civicrm_api3_phone_create($params) { | |
| 51 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 52 | } | |
| 53 | ||
| 11e09c59 | 54 | /** |
| 6a488035 TO |
55 | * Adjust Metadata for Create action |
| 56 | * | |
| 57 | * The metadata is used for setting defaults, documentation & validation | |
| 58 | * @param array $params array or parameters determined by getfields | |
| 59 | */ | |
| 60 | function _civicrm_api3_phone_create_spec(&$params) { | |
| 61 | $params['contact_id']['api.required'] = 1; | |
| 62 | $params['phone']['api.required'] = 1; | |
| 63 | // hopefully change to use handleprimary | |
| 64 | $params['is_primary']['api.default'] = 0; | |
| 65 | } | |
| 66 | ||
| 67 | /** | |
| 68 | * Deletes an existing Phone | |
| 69 | * | |
| 70 | * @param array $params | |
| 71 | * | |
| 72 | * @return array Api Result | |
| 73 | * {@getfields phone_delete} | |
| 74 | * @example PhoneDelete.php | |
| 75 | * @access public | |
| 76 | */ | |
| 77 | function civicrm_api3_phone_delete($params) { | |
| c48ed6b5 | 78 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 6a488035 TO |
79 | } |
| 80 | ||
| 81 | /** | |
| 82 | * civicrm_api('Phone','Get') to retrieve one or more phones is implemented by | |
| 83 | * function civicrm_api3_phone_get ($params) into the file Phone/Get.php | |
| 84 | * Could have been implemented here in this file too, but we moved it to illustrate the feature with a real usage. | |
| 85 | * | |
| 86 | */ | |
| 87 |