api/v3/LineItem.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 /**
  30  * This api exposes CiviCRM line item.
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35 /**
  36  * Create or update a line_item.
  37  *
  38  * @param array $params
  39  *   Array of property name/value pairs to insert in new 'line_item'
  40  *
  41  * @return array
  42  *   api result array
  43  */
  44 function civicrm_api3_line_item_create($params) {
  45   $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params, TRUE);
  46   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  47 }
  48
  49 /**
  50  * Adjust Metadata for Create action.
  51  *
  52  * The metadata is used for setting defaults, documentation & validation.
  53  *
  54  * @param array $params
  55  *   Array of parameters determined by getfields.
  56  */
  57 function _civicrm_api3_line_item_create_spec(&$params) {
  58   $params['entity_id']['api.required'] = 1;
  59   $params['qty']['api.required'] = 1;
  60   $params['unit_price']['api.required'] = 1;
  61   $params['line_total']['api.required'] = 1;
  62   $params['label']['api.default'] = 'line item';
  63 }
  64
  65 /**
  66  * Returns array of line_items  matching a set of one or more group properties.
  67  *
  68  * @param array $params
  69  *   Array of one or more valid property_name=>value pairs. If $params is set.
  70  *   as null, all line_items will be returned (default limit is 25)
  71  *
  72  * @return array
  73  *   Array of matching line_items
  74  */
  75 function civicrm_api3_line_item_get($params) {
  76   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }
  78
  79 /**
  80  * Delete an existing line_item.
  81  *
  82  * This method is used to delete any existing line_item. id of the group
  83  * to be deleted is required field in $params array
  84  *
  85  * @param array $params
  86  *   Array containing id of the group to be deleted.
  87  *
  88  * @return array
  89  *   API result array
  90  */
  91 function civicrm_api3_line_item_delete($params) {
  92   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  93 }