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