api/v3/Grant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * This api exposes CiviCRM Grant records.
  30  *
  31  * @note Grant component must be enabled.
  32  *
  33  * @package CiviCRM_APIv3
  34  */
  35
  36 /**
  37  * Create/update Grant.
  38  *
  39  * @param array $params
  40  *   Array per getfields metadata.
  41  *
  42  * @return array
  43  */
  44 function civicrm_api3_grant_create($params) {
  45   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant');
  46 }
  47
  48 /**
  49  * Adjust Metadata for Create action.
  50  *
  51  * The metadata is used for setting defaults, documentation & validation.
  52  *
  53  * @param array $params
  54  *   Array of parameters determined by getfields.
  55  */
  56 function _civicrm_api3_grant_create_spec(&$params) {
  57   $params['contact_id']['api.required'] = 1;
  58   $params['grant_type_id']['api.required'] = 1;
  59   $params['status_id']['api.required'] = 1;
  60   $params['amount_total']['api.required'] = 1;
  61   $params['status_id']['api.aliases'] = ['grant_status'];
  62 }
  63
  64 /**
  65  * Returns array of grants matching a set of one or more properties.
  66  *
  67  * @param array $params
  68  *   Array per getfields metadata.
  69  *
  70  * @return array
  71  *   Array of matching grants
  72  */
  73 function civicrm_api3_grant_get($params) {
  74   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant');
  75 }
  76
  77 /**
  78  * This method is used to delete an existing Grant.
  79  *
  80  * @param array $params
  81  *   Id of the Grant to be deleted is required.
  82  *
  83  * @return array
  84  *   API Result Array
  85  */
  86 function civicrm_api3_grant_delete($params) {
  87   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  88 }