Merge branch '5.34' of https://github.com/civicrm/civicrm-core into upit

[civicrm-core.git] / api / v3 / Acl.php

<?php
/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */

/**
 * This api exposes CiviCRM Acl records.
 *
 * @package CiviCRM_APIv3
 */

/**
 * Save an Acl.
 *
 * @param array $params
 *
 * @return array
 *   API result array
 */
function civicrm_api3_acl_create($params) {
  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Acl');
}

/**
 * Acl create metadata.
 *
 * @param array $params
 */
function _civicrm_api3_acl_create_spec(&$params) {
  $params['is_active']['api.default'] = 1;
  $params['entity_table']['api.default'] = 'civicrm_acl_role';
}

/**
 * Get an Acl.
 *
 * @param array $params
 *
 * @return array
 *   API result array
 */
function civicrm_api3_acl_get($params) {
  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Delete an Acl.
 *
 * @param array $params
 *
 * @return array
 *   API result array
 */
function civicrm_api3_acl_delete($params) {
  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}