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