api/v3/Grant.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   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 group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Grant
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  37 /**
  38  * create/update grant
  39  *
  40  * This API is used to create new grant or update any of the existing
  41  * In case of updating existing grant, id of that particular grant must
  42  * be in $params array.
  43  *
  44  * @param array $params
  45  *   Associative array of property.
  46  *                       name/value pairs to insert in new 'grant'
  47  *
  48  * @return array
  49  *   grant array
  50  * {@getfields grant_create}
  51  * @access public
  52  */
  53 function civicrm_api3_grant_create($params) {
  54   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant');
  55 }
  56
  57 /**
  58  * Adjust Metadata for Create action
  59  *
  60  * The metadata is used for setting defaults, documentation & validation
  61  * @param array $params
  62  *   Array or parameters determined by getfields.
  63  */
  64 function _civicrm_api3_grant_create_spec(&$params) {
  65   $params['grant_type_id']['api.required'] = 1;
  66   $params['status_id']['api.aliases'] = array('grant_status');
  67 }
  68
  69 /**
  70  * Returns array of grants  matching a set of one or more group properties
  71  *
  72  * @param array $params
  73  *   Array of one or more valid.
  74  *                       property_name=>value pairs. If $params is set
  75  *                       as null, all grants will be returned
  76  *
  77  * @return array
  78  *   Array of matching grants
  79  * {@getfields grant_get}
  80  * @access public
  81  */
  82 function civicrm_api3_grant_get($params) {
  83   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant');
  84 }
  85
  86 /**
  87  * delete an existing grant
  88  *
  89  * This method is used to delete any existing grant. id of the group
  90  * to be deleted is required field in $params array
  91  *
  92  * @param array $params
  93  *   Array containing id of the group.
  94  *                       to be deleted
  95  *
  96  * @return array
  97  *   API Result Array
  98  * {@getfields grant_delete}
  99  * @access public
 100  */
 101 function civicrm_api3_grant_delete($params) {
 102   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 103 }