<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- * File for the CiviCRM APIv3 acl_role functions
+ * This api exposes CiviCRM AclRole.
*
* @package CiviCRM_APIv3
- * @subpackage API_acl_role
- *
*/
/**
- * Save an acl_role
- *
- * Allowed @params array keys are:
- * {@getfields acl_role_create}
- * @example acl_roleCreate.php
+ * Save an AclRole.
*
* @param array $params
*
* @return array
- * of newly created acl_role property values.
- * @access public
*/
function civicrm_api3_acl_role_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Get an acl_role
- *
- * Allowed @params array keys are:
- * {@getfields acl_role_get}
- * @example acl_roleCreate.php
+ * Get an AclRole.
*
* @param array $params
*
* @return array
- * of retrieved acl_role property values.
- * @access public
+ * Array of retrieved AclRole property values.
*/
function civicrm_api3_acl_role_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Delete an acl_role
- *
- * Allowed @params array keys are:
- * {@getfields acl_role_delete}
- * @example acl_roleCreate.php
+ * Delete an AclRole.
*
* @param array $params
*
* @return array
- * of deleted values.
- * @access public
+ * Array of deleted values.
*/
function civicrm_api3_acl_role_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);