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 * Allowed @params array keys are:
42 * {@getfields website_create}
43 * @example WebsiteCreate.php
44 * {@example WebsiteCreate.php}
46 * @param array $params
49 * Array of newly created website property values.
50 * @todo convert to using basic create - BAO function non-std
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
55 $websiteBAO = CRM_Core_BAO_Website
::add($params);
57 _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id
]);
58 return civicrm_api3_create_success($values, $params, 'website', 'get');
62 * Adjust Metadata for Create action.
64 * The metadata is used for setting defaults, documentation & validation.
66 * @param array $params
67 * Array or parameters determined by getfields.
69 function _civicrm_api3_website_create_spec(&$params) {
70 $params['contact_id']['api.required'] = 1;
74 * Deletes an existing Website
75 * @todo convert to using Basic delete - BAO function non standard
76 * @param array $params
77 * {@getfields website_delete}
80 * @throws \API_Exception
82 function civicrm_api3_website_delete($params) {
83 //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
84 $websiteID = CRM_Utils_Array
::value('id', $params);
86 $websiteDAO = new CRM_Core_DAO_Website();
87 $websiteDAO->id
= $websiteID;
88 if ($websiteDAO->find()) {
89 while ($websiteDAO->fetch()) {
90 $websiteDAO->delete();
91 return civicrm_api3_create_success(1, $params, 'website', 'delete');
95 throw new API_Exception('Could not delete website with id ' . $websiteID);
100 * Retrieve one or more websites
102 * @param array $params
103 * {@example WebsiteGet.php 0}
104 * @example WebsiteGet.php
107 * details of found websites
110 function civicrm_api3_website_get($params) {
111 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'website');