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