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