api/v3/LineItem.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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   $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params, TRUE);
  48   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  49 }
  50
  51 /**
  52  * Adjust Metadata for Create action.
  53  *
  54  * The metadata is used for setting defaults, documentation & validation.
  55  *
  56  * @param array $params
  57  *   Array of parameters determined by getfields.
  58  */
  59 function _civicrm_api3_line_item_create_spec(&$params) {
  60   $params['entity_id']['api.required'] = 1;
  61   $params['qty']['api.required'] = 1;
  62   $params['unit_price']['api.required'] = 1;
  63   $params['line_total']['api.required'] = 1;
  64   $params['financial_type_id']['api.required'] = 1;
  65   $params['label']['api.default'] = 'line item';
  66 }
  67
  68 /**
  69  * Returns array of line_items  matching a set of one or more group properties.
  70  *
  71  * @param array $params
  72  *   Array of one or more valid property_name=>value pairs. If $params is set.
  73  *   as null, all line_items will be returned (default limit is 25)
  74  *
  75  * @return array
  76  *   Array of matching line_items
  77  */
  78 function civicrm_api3_line_item_get($params) {
  79   if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
  80     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types);
  81     $params['financial_type_id'] = array('IN' => array_keys($types));
  82   }
  83   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  84 }
  85
  86 /**
  87  * Delete an existing LineItem.
  88  *
  89  * This method is used to delete any existing LineItem given its id.
  90  *
  91  * @param array $params
  92  *   Array containing id of the group to be deleted.
  93  *
  94  * @return array
  95  *   API result array
  96  */
  97 function civicrm_api3_line_item_delete($params) {
  98   if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
  99     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, CRM_Core_Action::DELETE);
 100     if (empty($params['financial_type_id'])) {
 101       $params['financial_type_id'] = civicrm_api3('LineItem', 'getvalue', array(
 102         'id' => $params['id'],
 103         'return' => 'financial_type_id',
 104       ));
 105     }
 106     if (!in_array($params['financial_type_id'], array_keys($types))) {
 107       throw new API_Exception('You do not have permission to delete this line item');
 108     }
 109   }
 110   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 111 }