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 website functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_Website | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: Website.php 2011-03-16 ErikHommel $ |
36 | */ | |
37 | ||
6a488035 TO |
38 | /** |
39 | * Add an Website for a contact | |
40 | * | |
41 | * Allowed @params array keys are: | |
42 | * {@getfields website_create} | |
43 | * @example WebsiteCreate.php | |
44 | * {@example WebsiteCreate.php} | |
45 | * | |
c490a46a | 46 | * @param array $params |
77b97be7 | 47 | * |
a6c01b45 | 48 | * @return array |
16b10e64 | 49 | * Array of newly created website property values. |
6a488035 TO |
50 | * @todo convert to using basic create - BAO function non-std |
51 | */ | |
52 | function civicrm_api3_website_create($params) { | |
53 | //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
54 | ||
55 | $websiteBAO = CRM_Core_BAO_Website::add($params); | |
35671d00 TO |
56 | $values = array(); |
57 | _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]); | |
58 | return civicrm_api3_create_success($values, $params, 'website', 'get'); | |
11e09c59 | 59 | } |
6a488035 | 60 | |
11e09c59 | 61 | /** |
6a488035 TO |
62 | * Adjust Metadata for Create action |
63 | * | |
64 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
65 | * @param array $params |
66 | * Array or parameters determined by getfields. | |
6a488035 TO |
67 | */ |
68 | function _civicrm_api3_website_create_spec(&$params) { | |
69 | $params['contact_id']['api.required'] = 1; | |
70 | } | |
71 | ||
72 | /** | |
73 | * Deletes an existing Website | |
c23f45d3 | 74 | * @todo convert to using Basic delete - BAO function non standard |
cf470720 | 75 | * @param array $params |
6a488035 | 76 | * {@getfields website_delete} |
1bc8dc45 EM |
77 | * @return array |
78 | * API result | |
79 | * @throws \API_Exception | |
6a488035 TO |
80 | */ |
81 | function civicrm_api3_website_delete($params) { | |
82 | //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
83 | $websiteID = CRM_Utils_Array::value('id', $params); | |
84 | ||
85 | $websiteDAO = new CRM_Core_DAO_Website(); | |
86 | $websiteDAO->id = $websiteID; | |
87 | if ($websiteDAO->find()) { | |
88 | while ($websiteDAO->fetch()) { | |
89 | $websiteDAO->delete(); | |
90 | return civicrm_api3_create_success(1, $params, 'website', 'delete'); | |
91 | } | |
92 | } | |
93 | else { | |
1bc8dc45 | 94 | throw new API_Exception('Could not delete website with id ' . $websiteID); |
6a488035 TO |
95 | } |
96 | } | |
97 | ||
98 | /** | |
99 | * Retrieve one or more websites | |
100 | * | |
317fceb4 | 101 | * @param array $params |
6a488035 TO |
102 | * {@example WebsiteGet.php 0} |
103 | * @example WebsiteGet.php | |
6a488035 | 104 | * |
a6c01b45 | 105 | * @return array |
72b3a70c | 106 | * details of found websites |
6a488035 | 107 | * |
6a488035 TO |
108 | */ |
109 | function civicrm_api3_website_get($params) { | |
dc5a7701 | 110 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website'); |
6a488035 | 111 | } |