Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
b081365f | 29 | * This api exposes CiviCRM website records. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
1747ab99 | 35 | * Add an Website for a contact. |
6a488035 | 36 | * |
c490a46a | 37 | * @param array $params |
77b97be7 | 38 | * |
a6c01b45 | 39 | * @return array |
00f8641b | 40 | * API result array |
6a488035 TO |
41 | * @todo convert to using basic create - BAO function non-std |
42 | */ | |
43 | function civicrm_api3_website_create($params) { | |
44 | //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
45 | ||
46 | $websiteBAO = CRM_Core_BAO_Website::add($params); | |
35671d00 TO |
47 | $values = array(); |
48 | _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]); | |
244bbdd8 | 49 | return civicrm_api3_create_success($values, $params, 'Website', 'get'); |
11e09c59 | 50 | } |
6a488035 | 51 | |
11e09c59 | 52 | /** |
0aa0303c EM |
53 | * Adjust Metadata for Create action. |
54 | * | |
55 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 56 | * |
cf470720 | 57 | * @param array $params |
b081365f | 58 | * Array of parameters determined by getfields. |
6a488035 TO |
59 | */ |
60 | function _civicrm_api3_website_create_spec(&$params) { | |
61 | $params['contact_id']['api.required'] = 1; | |
62 | } | |
63 | ||
64 | /** | |
9d32e6f7 EM |
65 | * Deletes an existing Website. |
66 | * | |
c23f45d3 | 67 | * @todo convert to using Basic delete - BAO function non standard |
dc64d047 | 68 | * |
cf470720 | 69 | * @param array $params |
9d32e6f7 | 70 | * |
1bc8dc45 | 71 | * @return array |
00f8641b | 72 | * API result array |
1bc8dc45 | 73 | * @throws \API_Exception |
6a488035 TO |
74 | */ |
75 | function civicrm_api3_website_delete($params) { | |
76 | //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
77 | $websiteID = CRM_Utils_Array::value('id', $params); | |
78 | ||
79 | $websiteDAO = new CRM_Core_DAO_Website(); | |
80 | $websiteDAO->id = $websiteID; | |
81 | if ($websiteDAO->find()) { | |
82 | while ($websiteDAO->fetch()) { | |
83 | $websiteDAO->delete(); | |
244bbdd8 | 84 | return civicrm_api3_create_success(1, $params, 'Website', 'delete'); |
6a488035 TO |
85 | } |
86 | } | |
87 | else { | |
244bbdd8 | 88 | throw new API_Exception('Could not delete Website with id ' . $websiteID); |
6a488035 TO |
89 | } |
90 | } | |
91 | ||
92 | /** | |
9d32e6f7 | 93 | * Retrieve one or more websites. |
6a488035 | 94 | * |
317fceb4 | 95 | * @param array $params |
6a488035 | 96 | * |
a6c01b45 | 97 | * @return array |
00f8641b | 98 | * API result array |
6a488035 TO |
99 | */ |
100 | function civicrm_api3_website_get($params) { | |
244bbdd8 | 101 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Website'); |
6a488035 | 102 | } |