api/v3/Website.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * This api exposes CiviCRM website records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add an Website for a contact.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  *   API result array
  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   _civicrm_api3_check_edit_permissions('CRM_Core_BAO_Website', $params);
  46   $websiteBAO = CRM_Core_BAO_Website::add($params);
  47   $values = array();
  48   _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]);
  49   return civicrm_api3_create_success($values, $params, 'Website', 'get');
  50 }
  51
  52 /**
  53  * Adjust Metadata for Create action.
  54  *
  55  * The metadata is used for setting defaults, documentation & validation.
  56  *
  57  * @param array $params
  58  *   Array of parameters determined by getfields.
  59  */
  60 function _civicrm_api3_website_create_spec(&$params) {
  61   $params['contact_id']['api.required'] = 1;
  62 }
  63
  64 /**
  65  * Deletes an existing Website.
  66  *
  67  * @param array $params
  68  *
  69  * @return array
  70  *   API result array
  71  * @throws \API_Exception
  72  */
  73 function civicrm_api3_website_delete($params) {
  74   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  75 }
  76
  77 /**
  78  * Retrieve one or more websites.
  79  *
  80  * @param array $params
  81  *
  82  * @return array
  83  *   API result array
  84  */
  85 function civicrm_api3_website_get($params) {
  86   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Website');
  87 }