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