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