| 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_PriceFieldValue |
| 34 | * @copyright CiviCRM LLC (c) 20042012 |
| 35 | */ |
| 36 | |
| 37 | /** |
| 38 | * Create or update a price_field_value. |
| 39 | * |
| 40 | * @param array $params |
| 41 | * Array of property. |
| 42 | * name/value pairs to insert in new 'price_field_value' |
| 43 | * |
| 44 | * @return array |
| 45 | * API result array. |
| 46 | */ |
| 47 | function civicrm_api3_price_field_value_create($params) { |
| 48 | $ids = array(); |
| 49 | if (!empty($params['id'])) { |
| 50 | $ids['id'] = $params['id']; |
| 51 | } |
| 52 | |
| 53 | $bao = CRM_Price_BAO_PriceFieldValue::create($params, $ids); |
| 54 | |
| 55 | $values = array(); |
| 56 | _civicrm_api3_object_to_array($bao, $values[$bao->id]); |
| 57 | return civicrm_api3_create_success($values, $params, 'price_field_value', 'create', $bao); |
| 58 | |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Adjust Metadata for Create action. |
| 63 | * |
| 64 | * The metadata is used for setting defaults, documentation & validation. |
| 65 | * |
| 66 | * @param array $params |
| 67 | * Array or parameters determined by getfields. |
| 68 | */ |
| 69 | function _civicrm_api3_price_field_value_create_spec(&$params) { |
| 70 | $params['price_field_id']['api.required'] = TRUE; |
| 71 | $params['label']['api.required'] = TRUE; |
| 72 | $params['amount']['api.required'] = TRUE; |
| 73 | $params['is_active']['api.default'] = TRUE; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Returns array of price_field_values matching a set of one or more group properties. |
| 78 | * |
| 79 | * @param array $params |
| 80 | * Array of one or more valid property_name=>value pairs. If $params is set. |
| 81 | * as null, all price_field_values will be returned (default limit is 25) |
| 82 | * |
| 83 | * @return array |
| 84 | * API result array. |
| 85 | */ |
| 86 | function civicrm_api3_price_field_value_get($params) { |
| 87 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Delete an existing price_field_value. |
| 92 | * |
| 93 | * This method is used to delete any existing price_field_value. id of the group |
| 94 | * to be deleted is required field in $params array |
| 95 | * |
| 96 | * @param array $params |
| 97 | * Array containing id of the group. |
| 98 | * to be deleted |
| 99 | * |
| 100 | * @return array |
| 101 | * API result array. |
| 102 | */ |
| 103 | function civicrm_api3_price_field_value_delete($params) { |
| 104 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 105 | } |