3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 website functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Website
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Website.php 2011-03-16 ErikHommel $
39 * Add an Website for a contact.
41 * @param array $params
44 * Array of newly created website property values.
45 * @todo convert to using basic create - BAO function non-std
47 function civicrm_api3_website_create($params) {
48 //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
50 $websiteBAO = CRM_Core_BAO_Website
::add($params);
52 _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id
]);
53 return civicrm_api3_create_success($values, $params, 'website', 'get');
57 * Adjust Metadata for Create action.
59 * The metadata is used for setting defaults, documentation & validation.
61 * @param array $params
62 * Array or parameters determined by getfields.
64 function _civicrm_api3_website_create_spec(&$params) {
65 $params['contact_id']['api.required'] = 1;
69 * Deletes an existing Website.
71 * @todo convert to using Basic delete - BAO function non standard
72 * @param array $params
76 * @throws \API_Exception
78 function civicrm_api3_website_delete($params) {
79 //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
80 $websiteID = CRM_Utils_Array
::value('id', $params);
82 $websiteDAO = new CRM_Core_DAO_Website();
83 $websiteDAO->id
= $websiteID;
84 if ($websiteDAO->find()) {
85 while ($websiteDAO->fetch()) {
86 $websiteDAO->delete();
87 return civicrm_api3_create_success(1, $params, 'website', 'delete');
91 throw new API_Exception('Could not delete website with id ' . $websiteID);
96 * Retrieve one or more websites.
98 * @param array $params
101 * details of found websites
103 function civicrm_api3_website_get($params) {
104 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'website');