api/v3/Grant.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28  */
  29
  30 /**
  31  * File for the CiviCRM APIv3 group functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Grant
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  */
  37
  38 require_once 'CRM/Grant/BAO/Grant.php';
  39
  40 /**
  41  * create/update grant
  42  *
  43  * This API is used to create new grant or update any of the existing
  44  * In case of updating existing grant, id of that particular grant must
  45  * be in $params array.
  46  *
  47  * @param array $params  Associative array of property
  48  *                       name/value pairs to insert in new 'grant'
  49  *
  50  * @return array   grant array
  51  * {@getfields grant_create}
  52  * @access public
  53  */
  54 function civicrm_api3_grant_create($params) {
  55   $values = array();
  56   _civicrm_api3_custom_format_params($params, $values, 'Grant');
  57   $params = array_merge($values, $params);
  58   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'grant');
  59 }
  60
  61 /**
  62  * Adjust Metadata for Create action
  63  *
  64  * The metadata is used for setting defaults, documentation & validation
  65  * @param array $params array or parameters determined by getfields
  66  */
  67 function _civicrm_api3_grant_create_spec(&$params) {
  68   $params['grant_type_id']['api.required'] = 1;
  69 }
  70
  71 /**
  72  * Returns array of grants  matching a set of one or more group properties
  73  *
  74  * @param array $params  (referance) Array of one or more valid
  75  *                       property_name=>value pairs. If $params is set
  76  *                       as null, all grants will be returned
  77  *
  78  * @return array  (referance) 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);
  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   array containing id of the group
  93  *                       to be deleted
  94  *
  95  * @return array  API Result Array
  96  * {@getfields grant_delete}
  97  * @access public
  98  */
  99 function civicrm_api3_grant_delete($params) {
 100   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 101 }
 102