api/v3/Grant.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.4                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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  Associative array of property
  45  *                       name/value pairs to insert in new 'grant'
  46  *
  47  * @return array   grant array
  48  * {@getfields grant_create}
  49  * @access public
  50  */
  51 function civicrm_api3_grant_create($params) {
  52   $values = array();
  53   _civicrm_api3_custom_format_params($params, $values, 'Grant');
  54   $params = array_merge($values, $params);
  55   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'grant');
  56 }
  57
  58 /**
  59  * Adjust Metadata for Create action
  60  *
  61  * The metadata is used for setting defaults, documentation & validation
  62  * @param array $params array or parameters determined by getfields
  63  */
  64 function _civicrm_api3_grant_create_spec(&$params) {
  65   $params['grant_type_id']['api.required'] = 1;
  66 }
  67
  68 /**
  69  * Returns array of grants  matching a set of one or more group properties
  70  *
  71  * @param array $params  (referance) Array of one or more valid
  72  *                       property_name=>value pairs. If $params is set
  73  *                       as null, all grants will be returned
  74  *
  75  * @return array  (referance) Array of matching grants
  76  * {@getfields grant_get}
  77  * @access public
  78  */
  79 function civicrm_api3_grant_get($params) {
  80   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  81 }
  82
  83 /**
  84  * delete an existing grant
  85  *
  86  * This method is used to delete any existing grant. id of the group
  87  * to be deleted is required field in $params array
  88  *
  89  * @param array $params   array containing id of the group
  90  *                       to be deleted
  91  *
  92  * @return array  API Result Array
  93  * {@getfields grant_delete}
  94  * @access public
  95  */
  96 function civicrm_api3_grant_delete($params) {
  97   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  98 }
  99