api/v3/AclRole.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 acl_role functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_acl_role
  34  *
  35  */
  36
  37 /**
  38  * Save an acl_role
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields acl_role_create}
  42  * @example acl_roleCreate.php
  43  *
  44  * @return array of newly created acl_role property values.
  45  * @access public
  46  */
  47 function civicrm_api3_acl_role_create($params) {
  48   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  49 }
  50
  51 /**
  52  * Get an acl_role
  53  *
  54  * Allowed @params array keys are:
  55  * {@getfields acl_role_get}
  56  * @example acl_roleCreate.php
  57  *
  58  * @return array of retrieved acl_role property values.
  59  * @access public
  60  */
  61 function civicrm_api3_acl_role_get($params) {
  62   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  63 }
  64
  65 /**
  66  * Delete an acl_role
  67  *
  68  * Allowed @params array keys are:
  69  * {@getfields acl_role_delete}
  70  * @example acl_roleCreate.php
  71  *
  72  * @return array of deleted values.
  73  * @access public
  74  */
  75 function civicrm_api3_acl_role_delete($params) {
  76   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }