| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 | * This api exposes CiviCRM membership type. |
| 30 | * |
| 31 | * @package CiviCRM_APIv3 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * API to Create or update a Membership Type. |
| 36 | * |
| 37 | * @param array $params |
| 38 | * Array of name/value property values of civicrm_membership_type. |
| 39 | * |
| 40 | * @return array |
| 41 | * API result array. |
| 42 | */ |
| 43 | function civicrm_api3_membership_type_create($params) { |
| 44 | // Workaround for fields using nonstandard serialization |
| 45 | foreach (array('relationship_type_id', 'relationship_direction') as $field) { |
| 46 | if (isset($params[$field]) && is_array($params[$field])) { |
| 47 | $params[$field] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params[$field]); |
| 48 | } |
| 49 | } |
| 50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Membership_type'); |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Adjust Metadata for Create action. |
| 55 | * |
| 56 | * The metadata is used for setting defaults, documentation & validation. |
| 57 | * |
| 58 | * @param array $params |
| 59 | * Array of parameters determined by getfields. |
| 60 | */ |
| 61 | function _civicrm_api3_membership_type_create_spec(&$params) { |
| 62 | // todo could set default here probably |
| 63 | $params['domain_id']['api.required'] = 1; |
| 64 | $params['member_of_contact_id']['api.required'] = 1; |
| 65 | $params['financial_type_id']['api.required'] = 1; |
| 66 | $params['name']['api.required'] = 1; |
| 67 | $params['duration_unit']['api.required'] = 1; |
| 68 | $params['duration_interval']['api.required'] = 1; |
| 69 | $params['is_active']['api.default'] = 1; |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Get a Membership Type. |
| 74 | * |
| 75 | * This api is used for finding an existing membership type. |
| 76 | * |
| 77 | * @param array $params |
| 78 | * Array of name/value property values of civicrm_membership_type. |
| 79 | * |
| 80 | * @return array |
| 81 | * API result array. |
| 82 | */ |
| 83 | function civicrm_api3_membership_type_get($params) { |
| 84 | $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 85 | if (!empty($results['values'])) { |
| 86 | foreach ($results['values'] as &$item) { |
| 87 | // Workaround for fields using nonstandard serialization |
| 88 | foreach (array('relationship_type_id', 'relationship_direction') as $field) { |
| 89 | if (isset($item[$field]) && !is_array($item[$field])) { |
| 90 | $item[$field] = (array) $item[$field]; |
| 91 | } |
| 92 | } |
| 93 | } |
| 94 | } |
| 95 | return $results; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Deletes an existing membership type. |
| 100 | * |
| 101 | * @param array $params |
| 102 | * |
| 103 | * @return array |
| 104 | * API result array. |
| 105 | */ |
| 106 | function civicrm_api3_membership_type_delete($params) { |
| 107 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 108 | } |