api/v3/Acl.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 functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_acl
  34  *
  35  */
  36
  37 /**
  38  * Save an acl
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields acl_create}
  42  * @example aclCreate.php
  43  *
  44  * @param array $params
  45  *
  46  * @return array of newly created acl property values.
  47  * @access public
  48  */
  49 function civicrm_api3_acl_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Get an acl
  55  *
  56  * Allowed @params array keys are:
  57  * {@getfields acl_get}
  58  * @example aclCreate.php
  59  *
  60  * @param array $params
  61  *
  62  * @return array of retrieved acl property values.
  63  * @access public
  64  */
  65 function civicrm_api3_acl_get($params) {
  66   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  67 }
  68
  69 /**
  70  * Delete an acl
  71  *
  72  * Allowed @params array keys are:
  73  * {@getfields acl_delete}
  74  * @example aclCreate.php
  75  *
  76  * @param array $params
  77  *
  78  * @return array of deleted values.
  79  * @access public
  80  */
  81 function civicrm_api3_acl_delete($params) {
  82   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  83 }