api/v3/MembershipBlock.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM MembershipBlock records.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * API to Create or update a MembershipBlock.
  20  *
  21  * @param array $params
  22  *   An associative array of name/value property values of MembershipBlock.
  23  *
  24  * @return array
  25  *   API result array
  26  */
  27 function civicrm_api3_membership_block_create($params) {
  28   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'MembershipBlock');
  29 }
  30
  31 /**
  32  * Adjust Metadata for Create action.
  33  *
  34  * The metadata is used for setting defaults, documentation & validation.
  35  *
  36  * @param array $params
  37  *   Array of parameters determined by getfields.
  38  */
  39 function _civicrm_api3_membership_block_create_spec(&$params) {
  40   $params['is_active']['api.default'] = TRUE;
  41   $params['entity_id']['api.required'] = TRUE;
  42   $params['entity_table']['api.default'] = 'civicrm_contribution_page';
  43 }
  44
  45 /**
  46  * Get a Membership Block.
  47  *
  48  * This api is used for finding an existing membership block.
  49  *
  50  * @param array $params
  51  *   An associative array of name/value property values of civicrm_membership_block.
  52  * {getfields MembershipBlock_get}
  53  *
  54  * @return array
  55  *   API result array
  56  */
  57 function civicrm_api3_membership_block_get($params) {
  58   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  59 }
  60
  61 /**
  62  * Deletes an existing membership block.
  63  *
  64  * This API is used for deleting a membership block
  65  * Required parameters : id of a membership block
  66  *
  67  * @param array $params
  68  *
  69  * @return array
  70  *   API result array
  71  */
  72 function civicrm_api3_membership_block_delete($params) {
  73   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  74 }