api/v3/AclRole.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 acl_role functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_acl_role
  33  *
  34  */
  35
  36 /**
  37  * Save an acl_role
  38  *
  39  * Allowed @params array keys are:
  40  * {@getfields acl_role_create}
  41  * @example acl_roleCreate.php
  42  *
  43  * @param array $params
  44  *
  45  * @return array
  46  *   Array of newly created acl_role property values.
  47  */
  48 function civicrm_api3_acl_role_create($params) {
  49   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  50 }
  51
  52 /**
  53  * Get an acl_role
  54  *
  55  * Allowed @params array keys are:
  56  * {@getfields acl_role_get}
  57  * @example acl_roleCreate.php
  58  *
  59  * @param array $params
  60  *
  61  * @return array
  62  *   Array of retrieved acl_role property values.
  63  */
  64 function civicrm_api3_acl_role_get($params) {
  65   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  66 }
  67
  68 /**
  69  * Delete an acl_role
  70  *
  71  * Allowed @params array keys are:
  72  * {@getfields acl_role_delete}
  73  * @example acl_roleCreate.php
  74  *
  75  * @param array $params
  76  *
  77  * @return array
  78  *   Array of deleted values.
  79  */
  80 function civicrm_api3_acl_role_delete($params) {
  81   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  82 }