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