api/v3/LineItem.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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 /**
  30  * This api exposes CiviCRM LineItem records.
  31  *
  32  * Line items are sub-components of a complete financial transaction record.
  33  *
  34  * @package CiviCRM_APIv3
  35  */
  36
  37 /**
  38  * Create or update a line_item.
  39  *
  40  * @param array $params
  41  *   Array of property name/value pairs to insert in new 'line_item'
  42  *
  43  * @return array
  44  *   api result array
  45  */
  46 function civicrm_api3_line_item_create($params) {
  47   // @todo the following line is not really appropriate for the api. The BAO should
  48   // do the work, and it should be in a tighter function. The below function is  not really
  49   // readable because it is handling contribution and line item together.
  50   $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params, TRUE);
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'LineItem');
  52 }
  53
  54 /**
  55  * Adjust Metadata for Create action.
  56  *
  57  * The metadata is used for setting defaults, documentation & validation.
  58  *
  59  * @param array $params
  60  *   Array of parameters determined by getfields.
  61  */
  62 function _civicrm_api3_line_item_create_spec(&$params) {
  63   $params['entity_id']['api.required'] = 1;
  64   $params['qty']['api.required'] = 1;
  65   $params['unit_price']['api.required'] = 1;
  66   $params['line_total']['api.required'] = 1;
  67   $params['label']['api.default'] = 'line item';
  68 }
  69
  70 /**
  71  * Returns array of line_items  matching a set of one or more group properties.
  72  *
  73  * @param array $params
  74  *   Array of one or more valid property_name=>value pairs. If $params is set.
  75  *   as null, all line_items will be returned (default limit is 25)
  76  *
  77  * @return array
  78  *   Array of matching line_items
  79  */
  80 function civicrm_api3_line_item_get($params) {
  81   if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && !empty($params['check_permissions'])) {
  82     CRM_Price_BAO_LineItem::getAPILineItemParams($params);
  83   }
  84   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  85 }
  86
  87 /**
  88  * Delete an existing LineItem.
  89  *
  90  * This method is used to delete any existing LineItem given its id.
  91  *
  92  * @param array $params
  93  *   Array containing id of the group to be deleted.
  94  * @return array API result array
  95  * @throws API_Exception
  96  */
  97 function civicrm_api3_line_item_delete($params) {
  98   if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && !empty($params['check_permissions'])) {
  99     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, CRM_Core_Action::DELETE);
 100     if (empty($params['financial_type_id'])) {
 101       $params['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_LineItem', $params['id'], 'financial_type_id');
 102     }
 103     if (!in_array($params['financial_type_id'], array_keys($types))) {
 104       throw new API_Exception('You do not have permission to delete this line item');
 105     }
 106   }
 107   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 108 }