api/v3/Website.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Website.php 2011-03-16 ErikHommel $
  36  */
  37
  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  *
  46  * @param array $params
  47  *
  48  * @return array
  49  *   Array of newly created website property values.
  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);
  56   $values = array();
  57   _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]);
  58   return civicrm_api3_create_success($values, $params, 'website', 'get');
  59 }
  60
  61 /**
  62  * Adjust Metadata for Create action
  63  *
  64  * The metadata is used for setting defaults, documentation & validation
  65  * @param array $params
  66  *   Array or parameters determined by getfields.
  67  */
  68 function _civicrm_api3_website_create_spec(&$params) {
  69   $params['contact_id']['api.required'] = 1;
  70 }
  71
  72 /**
  73  * Deletes an existing Website
  74  * @todo convert to using Basic delete - BAO function non standard
  75  * @param array $params
  76  * {@getfields website_delete}
  77  * @return array
  78  *   API result
  79  * @throws \API_Exception
  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     throw new API_Exception('Could not delete website with id ' . $websiteID);
  95   }
  96 }
  97
  98 /**
  99  * Retrieve one or more websites
 100  *
 101  * @param array $params
 102  * {@example WebsiteGet.php 0}
 103  * @example WebsiteGet.php
 104  *
 105  * @return array
 106  *   details of found websites
 107  *
 108  */
 109 function civicrm_api3_website_get($params) {
 110   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website');
 111 }