Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
39de6fd5 | 5 | | CiviCRM version 4.6 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * File for the CiviCRM APIv3 phone functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Phone | |
34 | * | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * @version $Id: Phone.php 2011-03-16 ErikHommel $ |
37 | */ | |
38 | ||
6a488035 TO |
39 | /** |
40 | * Add an Phone for a contact | |
41 | * | |
42 | * Allowed @params array keys are: | |
43 | * {@getfields phone_create} | |
44 | * @example PhoneCreate.php | |
45 | * | |
c490a46a | 46 | * @param array $params |
77b97be7 | 47 | * |
6a488035 TO |
48 | * @return array of newly created phone property values. |
49 | * @access public | |
50 | */ | |
51 | function civicrm_api3_phone_create($params) { | |
52 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
53 | } | |
54 | ||
11e09c59 | 55 | /** |
6a488035 | 56 | * Adjust Metadata for Create action |
1c88e578 | 57 | * |
6a488035 TO |
58 | * The metadata is used for setting defaults, documentation & validation |
59 | * @param array $params array or parameters determined by getfields | |
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 | * | |
71 | * @param array $params | |
72 | * | |
73 | * @return array Api Result | |
74 | * {@getfields phone_delete} | |
75 | * @example PhoneDelete.php | |
76 | * @access public | |
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 | */ | |
88 |