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