api/v3/AclRole.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 AclRole.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Save an AclRole.
  20  *
  21  * @param array $params
  22  *
  23  * @return array
  24  *   API result array
  25  */
  26 function civicrm_api3_acl_role_create($params) {
  27   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'EntityRole');
  28 }
  29
  30 /**
  31  * AclRole create metadata.
  32  *
  33  * @param array $params
  34  */
  35 function _civicrm_api3_acl_role_create_spec(&$params) {
  36   $params['is_active']['api.default'] = 1;
  37 }
  38
  39 /**
  40  * Get an AclRole.
  41  *
  42  * @param array $params
  43  *
  44  * @return array
  45  *   API result array
  46  */
  47 function civicrm_api3_acl_role_get($params) {
  48   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  49 }
  50
  51 /**
  52  * Delete an AclRole.
  53  *
  54  * @param array $params
  55  *
  56  * @return array
  57  *   API result array
  58  */
  59 function civicrm_api3_acl_role_delete($params) {
  60   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  61 }