api/v3/Website.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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  * @param array $params
  48  *
  49  * @return array of newly created website property values.
  50  * @access public
  51  * @todo convert to using basic create - BAO function non-std
  52  */
  53 function civicrm_api3_website_create($params) {
  54   //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  55
  56   $websiteBAO = CRM_Core_BAO_Website::add($params);
  57   $values = array();
  58   _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]);
  59   return civicrm_api3_create_success($values, $params, 'website', 'get');
  60 }
  61
  62 /**
  63  * Adjust Metadata for Create action
  64  *
  65  * The metadata is used for setting defaults, documentation & validation
  66  * @param array $params
  67  *   Array or parameters determined by getfields.
  68  */
  69 function _civicrm_api3_website_create_spec(&$params) {
  70   $params['contact_id']['api.required'] = 1;
  71 }
  72
  73 /**
  74  * Deletes an existing Website
  75  *
  76  * @param array $params
  77  * {@getfields website_delete}
  78  * @example WebsiteDelete.php Std Delete Example
  79  *
  80  * @return array API result Array
  81  * @access public
  82  * @todo convert to using Basic delete - BAO function non standard
  83  */
  84 function civicrm_api3_website_delete($params) {
  85   //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  86   $websiteID = CRM_Utils_Array::value('id', $params);
  87
  88   $websiteDAO = new CRM_Core_DAO_Website();
  89   $websiteDAO->id = $websiteID;
  90   if ($websiteDAO->find()) {
  91     while ($websiteDAO->fetch()) {
  92       $websiteDAO->delete();
  93       return civicrm_api3_create_success(1, $params, 'website', 'delete');
  94     }
  95   }
  96   else {
  97     return civicrm_api3_create_error('Could not delete website with id ' . $websiteID);
  98   }
  99 }
 100
 101 /**
 102  * Retrieve one or more websites
 103  *
 104  * @param mixed[] (reference ) input parameters
 105  * {@getfields website_get}
 106  * {@example WebsiteGet.php 0}
 107  * @example WebsiteGet.php
 108  * @param array $params
 109  *   An associative array of name/value pairs.
 110  *
 111  * @return  array details of found websites
 112  *
 113  * @access public
 114  */
 115 function civicrm_api3_website_get($params) {
 116   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website');
 117 }