Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
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 phone functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_Phone | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: Phone.php 2011-03-16 ErikHommel $ |
36 | */ | |
37 | ||
6a488035 TO |
38 | /** |
39 | * Add an Phone for a contact | |
40 | * | |
41 | * Allowed @params array keys are: | |
42 | * {@getfields phone_create} | |
43 | * @example PhoneCreate.php | |
44 | * | |
c490a46a | 45 | * @param array $params |
77b97be7 | 46 | * |
a6c01b45 | 47 | * @return array |
16b10e64 | 48 | * Array of newly created phone property values. |
6a488035 TO |
49 | */ |
50 | function civicrm_api3_phone_create($params) { | |
decc60a0 | 51 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Phone'); |
6a488035 TO |
52 | } |
53 | ||
11e09c59 | 54 | /** |
6a488035 | 55 | * Adjust Metadata for Create action |
1c88e578 | 56 | * |
6a488035 | 57 | * The metadata is used for setting defaults, documentation & validation |
cf470720 TO |
58 | * @param array $params |
59 | * Array or parameters determined by getfields. | |
6a488035 TO |
60 | */ |
61 | function _civicrm_api3_phone_create_spec(&$params) { | |
62 | $params['contact_id']['api.required'] = 1; | |
63 | $params['phone']['api.required'] = 1; | |
64 | // hopefully change to use handleprimary | |
65 | $params['is_primary']['api.default'] = 0; | |
66 | } | |
67 | ||
68 | /** | |
69 | * Deletes an existing Phone | |
70 | * | |
cf470720 | 71 | * @param array $params |
6a488035 | 72 | * |
a6c01b45 | 73 | * @return array |
72b3a70c | 74 | * Api Result |
28a04ea9 | 75 | * {@getfields phone_delete} |
6a488035 | 76 | * @example PhoneDelete.php |
6a488035 TO |
77 | */ |
78 | function civicrm_api3_phone_delete($params) { | |
c48ed6b5 | 79 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 TO |
80 | } |
81 | ||
82 | /** | |
83 | * civicrm_api('Phone','Get') to retrieve one or more phones is implemented by | |
84 | * function civicrm_api3_phone_get ($params) into the file Phone/Get.php | |
85 | * Could have been implemented here in this file too, but we moved it to illustrate the feature with a real usage. | |
86 | * | |
87 | */ |