api/v3/Product.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   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 product functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_product
  34  *
  35  */
  36
  37 /**
  38  * Save a product
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields product_create}
  42  * @example productCreate.php
  43  *
  44  * @param $params
  45  *
  46  * @throws API_Exception
  47  * @return array of newly created product property values.
  48  * @access public
  49  */
  50 function civicrm_api3_product_create($params) {
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  52 }
  53
  54 /**
  55  * Get a product
  56  *
  57  * Allowed @params array keys are:
  58  * {@getfields product_get}
  59  * @example productCreate.php
  60  *
  61  * @param $params
  62  *
  63  * @return array of retrieved product property values.
  64  * @access public
  65  */
  66 function civicrm_api3_product_get($params) {
  67   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  68 }
  69
  70 /**
  71  * Delete a product
  72  *
  73  * Allowed @params array keys are:
  74  * {@getfields product_delete}
  75  * @example productCreate.php
  76  *
  77  * @param $params
  78  *
  79  * @throws API_Exception
  80  * @return array of deleted values.
  81  * @access public
  82  */
  83 function civicrm_api3_product_delete($params) {
  84   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  85 }