api/v3/PriceFieldValue.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 price field values.
  31  *
  32  * PriceFields may contain zero or more PriceFieldValues.
  33  * Use chaining to create PriceFields and values in one api call.
  34  *
  35  * @package CiviCRM_APIv3
  36  */
  37
  38 /**
  39  * Create or update a PriceFieldValue.
  40  *
  41  * @param array $params
  42  *   name/value pairs to insert in new 'PriceFieldValue'
  43  *
  44  * @return array
  45  *   API result array.
  46  */
  47 function civicrm_api3_price_field_value_create($params) {
  48   $ids = array();
  49   if (!empty($params['id'])) {
  50     $ids['id'] = $params['id'];
  51   }
  52
  53   $bao = CRM_Price_BAO_PriceFieldValue::create($params, $ids);
  54
  55   $values = array();
  56   _civicrm_api3_object_to_array($bao, $values[$bao->id]);
  57   return civicrm_api3_create_success($values, $params, 'PriceFieldValue', 'create', $bao);
  58
  59 }
  60
  61 /**
  62  * Adjust Metadata for Create action.
  63  *
  64  * The metadata is used for setting defaults, documentation & validation.
  65  *
  66  * @param array $params
  67  *   Array of parameters determined by getfields.
  68  */
  69 function _civicrm_api3_price_field_value_create_spec(&$params) {
  70   $params['price_field_id']['api.required'] = TRUE;
  71   $params['label']['api.required'] = TRUE;
  72   $params['amount']['api.required'] = TRUE;
  73   $params['is_active']['api.default'] = TRUE;
  74   $params['financial_type_id']['api.default'] = TRUE;
  75 }
  76
  77 /**
  78  * Returns array of PriceFieldValues  matching a set of one or more group properties.
  79  *
  80  * @param array $params
  81  *   Array of one or more valid property_name=>value pairs. If $params is set.
  82  *   as null, all price_field_values will be returned (default limit is 25)
  83  *
  84  * @return array
  85  *   API result array.
  86  */
  87 function civicrm_api3_price_field_value_get($params) {
  88   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  89 }
  90
  91 /**
  92  * Delete an existing PriceFieldValue.
  93  *
  94  * This method is used to delete any existing PriceFieldValue given its id.
  95  *
  96  * @param array $params
  97  *   Array containing id of the group to be deleted.
  98  *
  99  * @return array
 100  *   API result array.
 101  */
 102 function civicrm_api3_price_field_value_delete($params) {
 103   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 104 }