| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.3 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 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 website functions |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | * @subpackage API_Website |
| 34 | * |
| 35 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 36 | * @version $Id: Website.php 2011-03-16 ErikHommel $ |
| 37 | */ |
| 38 | |
| 39 | /** |
| 40 | * Add an Website for a contact |
| 41 | * |
| 42 | * Allowed @params array keys are: |
| 43 | * {@getfields website_create} |
| 44 | * @example WebsiteCreate.php |
| 45 | * {@example WebsiteCreate.php} |
| 46 | * |
| 47 | * @return array of newly created website property values. |
| 48 | * @access public |
| 49 | * @todo convert to using basic create - BAO function non-std |
| 50 | */ |
| 51 | function civicrm_api3_website_create($params) { |
| 52 | //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards |
| 53 | |
| 54 | $websiteBAO = CRM_Core_BAO_Website::add($params); |
| 55 | $values = array(); |
| 56 | _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]); |
| 57 | return civicrm_api3_create_success($values, $params, 'website', 'get'); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Adjust Metadata for Create action |
| 62 | * |
| 63 | * The metadata is used for setting defaults, documentation & validation |
| 64 | * @param array $params array or parameters determined by getfields |
| 65 | */ |
| 66 | function _civicrm_api3_website_create_spec(&$params) { |
| 67 | $params['contact_id']['api.required'] = 1; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Deletes an existing Website |
| 72 | * |
| 73 | * @param array $params |
| 74 | * {@getfields website_delete} |
| 75 | * @example WebsiteDelete.php Std Delete Example |
| 76 | * |
| 77 | * @return array API result Array |
| 78 | * @access public |
| 79 | * @todo convert to using Basic delete - BAO function non standard |
| 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 { |
| 94 | return civicrm_api3_create_error('Could not delete website with id ' . $websiteID); |
| 95 | } |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Retrieve one or more websites |
| 100 | * |
| 101 | * @param mixed[] (reference ) input parameters |
| 102 | * {@getfields website_get} |
| 103 | * {@example WebsiteGet.php 0} |
| 104 | * @example WebsiteGet.php |
| 105 | * @param array $params an associative array of name/value pairs. |
| 106 | * |
| 107 | * @return array details of found websites |
| 108 | * |
| 109 | * @access public |
| 110 | */ |
| 111 | function civicrm_api3_website_get($params) { |
| 112 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 113 | } |
| 114 | |