api/v3/PriceField.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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 set fields.
  31  *
  32  * PriceSets contain PriceFields, which may contain PriceFieldValues.
  33  * Each has its own api.
  34  * Use chaining to create a PriceSet and associated PriceFields and values in one api call.
  35  *
  36  * @package CiviCRM_APIv3
  37  */
  38
  39 /**
  40  * Create or update a price_field.
  41  *
  42  * @param array $params
  43  *   name/value pairs to insert in new 'price_field'
  44  *
  45  * @return array
  46  *   api result array
  47  */
  48 function civicrm_api3_price_field_create($params) {
  49   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'PriceField');
  50 }
  51
  52 /**
  53  * Adjust Metadata for Create action.
  54  *
  55  * The metadata is used for setting defaults, documentation & validation.
  56  *
  57  * @param array $params
  58  *   Array of parameters determined by getfields.
  59  */
  60 function _civicrm_api3_price_field_create_spec(&$params) {
  61   $params['label']['api.required'] = TRUE;
  62 }
  63
  64 /**
  65  * Returns array of price_fields matching a set of one or more group properties.
  66  *
  67  * @param array $params
  68  *   Array of one or more valid property_name=>value pairs. If $params is set.
  69  *   as null, all price_fields will be returned (default limit is 25)
  70  *
  71  * @return array
  72  *   Array of matching price_fields
  73  */
  74 function civicrm_api3_price_field_get($params) {
  75   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  76 }
  77
  78 /**
  79  * Delete an existing price_field.
  80  *
  81  * This method is used to delete any existing price_field given its id.
  82  *
  83  * @param array $params
  84  *   Array containing id of the group to be deleted.
  85  *
  86  * @return array
  87  *   API result array
  88  */
  89 function civicrm_api3_price_field_delete($params) {
  90   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  91 }