3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Grant_BAO_Grant
extends CRM_Grant_DAO_Grant
{
38 * static field for all the grant information that we can potentially export
42 static $_exportableFields = NULL;
47 function __construct() {
48 parent
::__construct();
52 * Function to get events Summary
58 * @return array Array of event summary values
60 static function getGrantSummary($admin = FALSE) {
62 SELECT status_id, count(id) as status_total
63 FROM civicrm_grant GROUP BY status_id";
65 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
69 $summary['total_grants'] = NULL;
70 $status = CRM_Core_PseudoConstant
::get('CRM_Grant_DAO_Grant', 'status_id');
72 foreach ($status as $id => $name) {
79 while ($dao->fetch()) {
80 $stats[$dao->status_id
] = array(
81 'label' => $status[$dao->status_id
],
82 'total' => $dao->status_total
,
84 $summary['total_grants'] +
= $dao->status_total
;
87 $summary['per_status'] = $stats;
92 * Function to get events Summary
96 * @return array Array of event summary values
98 static function getGrantStatusOptGroup() {
101 $params['name'] = CRM_Grant_BAO_Grant
::$statusGroupName;
105 $og = CRM_Core_BAO_OptionGroup
::retrieve($params, $defaults);
107 CRM_Core_Error
::fatal('No option group for grant statuses - database discrepancy! Make sure you loaded civicrm_data.mysql');
114 * Function to retrieve statistics for grants.
120 * @return array Array of grant summary statistics
122 static function getGrantStatistics($admin = FALSE) {
123 $grantStatuses = array();
127 * Takes a bunch of params that are needed to match certain criteria and
128 * retrieves the relevant objects. Typically the valid params are only
129 * contact_id. We'll tweak this function to be more full featured over a period
130 * of time. This is the inverse function of create. It also stores all the retrieved
131 * values in the default array
133 * @param array $params (reference ) an assoc array of name/value pairs
134 * @param array $defaults (reference ) an assoc array to hold the flattened values
136 * @return object CRM_Grant_BAO_ManageGrant object
140 static function retrieve(&$params, &$defaults) {
141 $grant = new CRM_Grant_DAO_Grant();
142 $grant->copyValues($params);
143 if ($grant->find(TRUE)) {
144 CRM_Core_DAO
::storeValues($grant, $defaults);
151 * function to add grant
153 * @param array $params reference array contains the values submitted by the form
154 * @param array $ids reference array contains the id
161 static function add(&$params, &$ids) {
163 if (!empty($ids['grant_id'])) {
164 CRM_Utils_Hook
::pre('edit', 'Grant', $ids['grant_id'], $params);
167 CRM_Utils_Hook
::pre('create', 'Grant', NULL, $params);
170 // first clean up all the money fields
171 $moneyFields = array(
176 foreach ($moneyFields as $field) {
177 if (isset($params[$field])) {
178 $params[$field] = CRM_Utils_Rule
::cleanMoney($params[$field]);
181 // convert dates to mysql format
183 'application_received_date',
185 'money_transfer_date',
189 foreach ($dates as $d) {
190 if (isset($params[$d])) {
191 $params[$d] = CRM_Utils_Date
::processDate($params[$d], NULL, TRUE);
194 $grant = new CRM_Grant_DAO_Grant();
195 $grant->id
= CRM_Utils_Array
::value('grant_id', $ids);
197 $grant->copyValues($params);
199 // set currency for CRM-1496
200 if (!isset($grant->currency
)) {
201 $config = CRM_Core_Config
::singleton();
202 $grant->currency
= $config->defaultCurrency
;
205 $result = $grant->save();
207 $url = CRM_Utils_System
::url('civicrm/contact/view/grant',
208 "action=view&reset=1&id={$grant->id}&cid={$grant->contact_id}&context=home"
211 $grantTypes = CRM_Core_PseudoConstant
::get('CRM_Grant_DAO_Grant', 'grant_type_id');
212 if (empty($params['skipRecentView'])) {
213 if(!isset($grant->contact_id
) ||
!isset($grant->grant_type_id
)){
216 $title = CRM_Contact_BAO_Contact
::displayName($grant->contact_id
) . ' - ' . ts('Grant') . ': ' . $grantTypes[$grant->grant_type_id
];
218 $recentOther = array();
219 if (CRM_Core_Permission
::checkActionPermission('CiviGrant', CRM_Core_Action
::UPDATE
)) {
220 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/grant',
221 "action=update&reset=1&id={$grant->id}&cid={$grant->contact_id}&context=home"
224 if (CRM_Core_Permission
::checkActionPermission('CiviGrant', CRM_Core_Action
::DELETE
)) {
225 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/grant',
226 "action=delete&reset=1&id={$grant->id}&cid={$grant->contact_id}&context=home"
230 // add the recently created Grant
231 CRM_Utils_Recent
::add($title,
241 if (!empty($ids['grant'])) {
242 CRM_Utils_Hook
::post('edit', 'Grant', $grant->id
, $grant);
245 CRM_Utils_Hook
::post('create', 'Grant', $grant->id
, $grant);
252 * function to create the event
254 * @param array $params reference array contains the values submitted by the form
255 * @param array $ids reference array contains the id
262 public static function create(&$params, &$ids) {
263 $transaction = new CRM_Core_Transaction();
265 $grant = self
::add($params, $ids);
267 if (is_a($grant, 'CRM_Core_Error')) {
268 $transaction->rollback();
272 $session = CRM_Core_Session
::singleton();
273 $id = $session->get('userID');
275 $id = CRM_Utils_Array
::value('contact_id', $params);
277 if (!empty($params['note']) || CRM_Utils_Array
::value('id', CRM_Utils_Array
::value('note', $ids))) {
279 'entity_table' => 'civicrm_grant',
280 'note' => $params['note'] = $params['note'] ?
$params['note'] : "null",
281 'entity_id' => $grant->id
,
283 'modified_date' => date('Ymd'),
286 CRM_Core_BAO_Note
::add($noteParams, (array) CRM_Utils_Array
::value('note', $ids));
288 // Log the information on successful add/edit of Grant
290 'entity_table' => 'civicrm_grant',
291 'entity_id' => $grant->id
,
292 'modified_id' => $id,
293 'modified_date' => date('Ymd'),
296 CRM_Core_BAO_Log
::add($logParams);
298 // add custom field values
299 if (!empty($params['custom']) && is_array($params['custom'])) {
300 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_grant', $grant->id
);
303 // check and attach and files as needed
304 CRM_Core_BAO_File
::processAttachment($params,
309 $transaction->commit();
315 * Function to delete the Contact
320 * @internal param int $cid contact id
325 static function deleteContact($id) {
326 $grant = new CRM_Grant_DAO_Grant();
327 $grant->contact_id
= $id;
333 * Function to delete the grant
335 * @param int $id grant id
342 static function del($id) {
343 CRM_Utils_Hook
::pre('delete', 'Grant', $id, CRM_Core_DAO
::$_nullArray);
345 $grant = new CRM_Grant_DAO_Grant();
350 // delete the recently created Grant
351 $grantRecent = array(
355 CRM_Utils_Recent
::del($grantRecent);
357 if ($grant->fetch()) {
358 $results = $grant->delete();
359 CRM_Utils_Hook
::post('delete', 'Grant', $grant->id
, $grant);
366 * combine all the exportable fields from the lower levels object
368 * @return array array of exportable Fields
372 static function &exportableFields() {
373 if (!self
::$_exportableFields) {
374 if (!self
::$_exportableFields) {
375 self
::$_exportableFields = array();
378 $grantFields = array(
379 'grant_status' => array(
380 'title' => 'Grant Status',
381 'name' => 'grant_status',
382 'data_type' => CRM_Utils_Type
::T_STRING
,
384 'grant_type' => array(
385 'title' => 'Grant Type',
386 'name' => 'grant_type',
387 'data_type' => CRM_Utils_Type
::T_STRING
,
389 'grant_money_transfer_date' => array(
390 'title' => 'Grant Money Transfer Date',
391 'name' => 'grant_money_transfer_date',
392 'data_type' => CRM_Utils_Type
::T_DATE
,
394 'grant_amount_requested' => array(
395 'title' => 'Grant Amount Requested',
396 'name' => 'grant_amount_requested',
397 'data_type' => CRM_Utils_Type
::T_FLOAT
,
399 'grant_application_received_date' => array(
400 'title' => 'Grant Application Recieved Date',
401 'name' => 'grant_application_received_date',
402 'data_type' => CRM_Utils_Type
::T_DATE
,
406 $fields = CRM_Grant_DAO_Grant
::export();
407 $grantNote = array('grant_note' => array('title' => ts('Grant Note'),
408 'name' => 'grant_note',
409 'data_type' => CRM_Utils_Type
::T_TEXT
,
411 $fields = array_merge($fields, $grantFields, $grantNote,
412 CRM_Core_BAO_CustomField
::getFieldsForImport('Grant')
414 self
::$_exportableFields = $fields;
417 return self
::$_exportableFields;
421 * Function to get grant record count for a Contact
425 * @internal param int $contactId Contact ID
427 * @return int count of grant records
431 static function getContactGrantCount($contactID) {
432 $query = "SELECT count(*) FROM civicrm_grant WHERE civicrm_grant.contact_id = {$contactID} ";
433 return CRM_Core_DAO
::singleValueQuery($query);