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  * File for the CiviCRM APIv3 group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_PriceField
  34  * @copyright CiviCRM LLC (c) 20042012
  35  */
  36
  37 /**
  38  * Create or update a price_field
  39  *
  40  * @param array $params
  41  *   Associative array of property.
  42  *                       name/value pairs to insert in new 'price_field'
  43  * @example PriceFieldCreate.php Std Create example
  44  *
  45  * @return array
  46  *   api result array
  47  *   {@getfields price_field_create}
  48  */
  49 function civicrm_api3_price_field_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params
  58  *   Array or 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  *   {@getfields price_field_get}
  74  */
  75 function civicrm_api3_price_field_get($params) {
  76   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }
  78
  79 /**
  80  * delete an existing price_field
  81  *
  82  * This method is used to delete any existing price_field. id of the group
  83  * to be deleted is required field in $params array
  84  *
  85  * @param array $params
  86  *   Array containing id of the group.
  87  *   to be deleted
  88  *
  89  * @return array
  90  *   API result array
  91  *   {@getfields price_field_delete}
  92  */
  93 function civicrm_api3_price_field_delete($params) {
  94   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95 }