api/v3/AclRole.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 AclRole.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Save an AclRole.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function civicrm_api3_acl_role_create($params) {
  43   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'EntityRole');
  44 }
  45
  46 /**
  47  * AclRole create metadata.
  48  *
  49  * @param array $params
  50  */
  51 function _civicrm_api3_acl_role_create_spec(&$params) {
  52   $params['is_active']['api.default'] = 1;
  53 }
  54
  55 /**
  56  * Get an AclRole.
  57  *
  58  * @param array $params
  59  *
  60  * @return array
  61  *   API result array
  62  */
  63 function civicrm_api3_acl_role_get($params) {
  64   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  65 }
  66
  67 /**
  68  * Delete an AclRole.
  69  *
  70  * @param array $params
  71  *
  72  * @return array
  73  *   API result array
  74  */
  75 function civicrm_api3_acl_role_delete($params) {
  76   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }