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