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