413 lines
12 KiB
PHP
413 lines
12 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
* $Id$
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Static field for all the grant information that we can potentially export.
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
static $_exportableFields = NULL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class constructor.
|
||
|
|
*/
|
||
|
|
public function __construct() {
|
||
|
|
parent::__construct();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get events Summary.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* @param bool $admin
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* Array of event summary values
|
||
|
|
*/
|
||
|
|
public static function getGrantSummary($admin = FALSE) {
|
||
|
|
$query = "
|
||
|
|
SELECT status_id, count(id) as status_total
|
||
|
|
FROM civicrm_grant GROUP BY status_id";
|
||
|
|
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($query);
|
||
|
|
|
||
|
|
$status = array();
|
||
|
|
$summary = array();
|
||
|
|
$summary['total_grants'] = NULL;
|
||
|
|
$status = CRM_Core_PseudoConstant::get('CRM_Grant_DAO_Grant', 'status_id');
|
||
|
|
|
||
|
|
foreach ($status as $id => $name) {
|
||
|
|
$stats[$id] = array(
|
||
|
|
'label' => $name,
|
||
|
|
'total' => 0,
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
$stats[$dao->status_id] = array(
|
||
|
|
'label' => $status[$dao->status_id],
|
||
|
|
'total' => $dao->status_total,
|
||
|
|
);
|
||
|
|
$summary['total_grants'] += $dao->status_total;
|
||
|
|
}
|
||
|
|
|
||
|
|
$summary['per_status'] = $stats;
|
||
|
|
return $summary;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get events Summary.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* Array of event summary values
|
||
|
|
*/
|
||
|
|
public static function getGrantStatusOptGroup() {
|
||
|
|
|
||
|
|
$params = array();
|
||
|
|
$params['name'] = CRM_Grant_BAO_Grant::$statusGroupName;
|
||
|
|
|
||
|
|
$defaults = array();
|
||
|
|
|
||
|
|
$og = CRM_Core_BAO_OptionGroup::retrieve($params, $defaults);
|
||
|
|
if (!$og) {
|
||
|
|
CRM_Core_Error::fatal('No option group for grant statuses - database discrepancy! Make sure you loaded civicrm_data.mysql');
|
||
|
|
}
|
||
|
|
|
||
|
|
return $og;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Fetch object based on array of properties.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
* @param array $defaults
|
||
|
|
* (reference ) an assoc array to hold the flattened values.
|
||
|
|
*
|
||
|
|
* @return CRM_Grant_BAO_ManageGrant
|
||
|
|
*/
|
||
|
|
public static function retrieve(&$params, &$defaults) {
|
||
|
|
$grant = new CRM_Grant_DAO_Grant();
|
||
|
|
$grant->copyValues($params);
|
||
|
|
if ($grant->find(TRUE)) {
|
||
|
|
CRM_Core_DAO::storeValues($grant, $defaults);
|
||
|
|
return $grant;
|
||
|
|
}
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add grant.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Reference array contains the values submitted by the form.
|
||
|
|
* @param array $ids
|
||
|
|
* Reference array contains the id.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*/
|
||
|
|
public static function add(&$params, &$ids) {
|
||
|
|
|
||
|
|
if (!empty($ids['grant_id'])) {
|
||
|
|
CRM_Utils_Hook::pre('edit', 'Grant', $ids['grant_id'], $params);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Utils_Hook::pre('create', 'Grant', NULL, $params);
|
||
|
|
}
|
||
|
|
|
||
|
|
// first clean up all the money fields
|
||
|
|
$moneyFields = array(
|
||
|
|
'amount_total',
|
||
|
|
'amount_granted',
|
||
|
|
'amount_requested',
|
||
|
|
);
|
||
|
|
foreach ($moneyFields as $field) {
|
||
|
|
if (isset($params[$field])) {
|
||
|
|
$params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// convert dates to mysql format
|
||
|
|
$dates = array(
|
||
|
|
'application_received_date',
|
||
|
|
'decision_date',
|
||
|
|
'money_transfer_date',
|
||
|
|
'grant_due_date',
|
||
|
|
);
|
||
|
|
|
||
|
|
foreach ($dates as $d) {
|
||
|
|
if (isset($params[$d])) {
|
||
|
|
$params[$d] = CRM_Utils_Date::processDate($params[$d], NULL, TRUE);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$grant = new CRM_Grant_DAO_Grant();
|
||
|
|
$grant->id = CRM_Utils_Array::value('grant_id', $ids);
|
||
|
|
|
||
|
|
$grant->copyValues($params);
|
||
|
|
|
||
|
|
// set currency for CRM-1496
|
||
|
|
if (!isset($grant->currency)) {
|
||
|
|
$config = CRM_Core_Config::singleton();
|
||
|
|
$grant->currency = $config->defaultCurrency;
|
||
|
|
}
|
||
|
|
|
||
|
|
$result = $grant->save();
|
||
|
|
|
||
|
|
$url = CRM_Utils_System::url('civicrm/contact/view/grant',
|
||
|
|
"action=view&reset=1&id={$grant->id}&cid={$grant->contact_id}&context=home"
|
||
|
|
);
|
||
|
|
|
||
|
|
$grantTypes = CRM_Core_PseudoConstant::get('CRM_Grant_DAO_Grant', 'grant_type_id');
|
||
|
|
if (empty($params['skipRecentView'])) {
|
||
|
|
if (!isset($grant->contact_id) || !isset($grant->grant_type_id)) {
|
||
|
|
$grant->find(TRUE);
|
||
|
|
}
|
||
|
|
$title = CRM_Contact_BAO_Contact::displayName($grant->contact_id) . ' - ' . ts('Grant') . ': ' . $grantTypes[$grant->grant_type_id];
|
||
|
|
|
||
|
|
$recentOther = array();
|
||
|
|
if (CRM_Core_Permission::checkActionPermission('CiviGrant', CRM_Core_Action::UPDATE)) {
|
||
|
|
$recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/grant',
|
||
|
|
"action=update&reset=1&id={$grant->id}&cid={$grant->contact_id}&context=home"
|
||
|
|
);
|
||
|
|
}
|
||
|
|
if (CRM_Core_Permission::checkActionPermission('CiviGrant', CRM_Core_Action::DELETE)) {
|
||
|
|
$recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/grant',
|
||
|
|
"action=delete&reset=1&id={$grant->id}&cid={$grant->contact_id}&context=home"
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
// add the recently created Grant
|
||
|
|
CRM_Utils_Recent::add($title,
|
||
|
|
$url,
|
||
|
|
$grant->id,
|
||
|
|
'Grant',
|
||
|
|
$grant->contact_id,
|
||
|
|
NULL,
|
||
|
|
$recentOther
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($ids['grant'])) {
|
||
|
|
CRM_Utils_Hook::post('edit', 'Grant', $grant->id, $grant);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
CRM_Utils_Hook::post('create', 'Grant', $grant->id, $grant);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create the event.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Reference array contains the values submitted by the form.
|
||
|
|
* @param array $ids
|
||
|
|
* Reference array contains the id.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*/
|
||
|
|
public static function create(&$params, &$ids) {
|
||
|
|
$transaction = new CRM_Core_Transaction();
|
||
|
|
|
||
|
|
$grant = self::add($params, $ids);
|
||
|
|
|
||
|
|
if (is_a($grant, 'CRM_Core_Error')) {
|
||
|
|
$transaction->rollback();
|
||
|
|
return $grant;
|
||
|
|
}
|
||
|
|
|
||
|
|
$session = CRM_Core_Session::singleton();
|
||
|
|
$id = $session->get('userID');
|
||
|
|
if (!$id) {
|
||
|
|
$id = CRM_Utils_Array::value('contact_id', $params);
|
||
|
|
}
|
||
|
|
if (!empty($params['note']) || CRM_Utils_Array::value('id', CRM_Utils_Array::value('note', $ids))) {
|
||
|
|
$noteParams = array(
|
||
|
|
'entity_table' => 'civicrm_grant',
|
||
|
|
'note' => $params['note'] = $params['note'] ? $params['note'] : "null",
|
||
|
|
'entity_id' => $grant->id,
|
||
|
|
'contact_id' => $id,
|
||
|
|
'modified_date' => date('Ymd'),
|
||
|
|
);
|
||
|
|
|
||
|
|
CRM_Core_BAO_Note::add($noteParams, (array) CRM_Utils_Array::value('note', $ids));
|
||
|
|
}
|
||
|
|
// Log the information on successful add/edit of Grant
|
||
|
|
$logParams = array(
|
||
|
|
'entity_table' => 'civicrm_grant',
|
||
|
|
'entity_id' => $grant->id,
|
||
|
|
'modified_id' => $id,
|
||
|
|
'modified_date' => date('Ymd'),
|
||
|
|
);
|
||
|
|
|
||
|
|
CRM_Core_BAO_Log::add($logParams);
|
||
|
|
|
||
|
|
// add custom field values
|
||
|
|
if (!empty($params['custom']) && is_array($params['custom'])) {
|
||
|
|
CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_grant', $grant->id);
|
||
|
|
}
|
||
|
|
|
||
|
|
// check and attach and files as needed
|
||
|
|
CRM_Core_BAO_File::processAttachment($params,
|
||
|
|
'civicrm_grant',
|
||
|
|
$grant->id
|
||
|
|
);
|
||
|
|
|
||
|
|
$transaction->commit();
|
||
|
|
|
||
|
|
return $grant;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete the Contact.
|
||
|
|
*
|
||
|
|
* @param int $id
|
||
|
|
* Contact id.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public static function deleteContact($id) {
|
||
|
|
$grant = new CRM_Grant_DAO_Grant();
|
||
|
|
$grant->contact_id = $id;
|
||
|
|
$grant->delete();
|
||
|
|
return FALSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete the grant.
|
||
|
|
*
|
||
|
|
* @param int $id
|
||
|
|
* Grant id.
|
||
|
|
*
|
||
|
|
* @return bool|mixed
|
||
|
|
*/
|
||
|
|
public static function del($id) {
|
||
|
|
CRM_Utils_Hook::pre('delete', 'Grant', $id, CRM_Core_DAO::$_nullArray);
|
||
|
|
|
||
|
|
$grant = new CRM_Grant_DAO_Grant();
|
||
|
|
$grant->id = $id;
|
||
|
|
|
||
|
|
$grant->find();
|
||
|
|
|
||
|
|
// delete the recently created Grant
|
||
|
|
$grantRecent = array(
|
||
|
|
'id' => $id,
|
||
|
|
'type' => 'Grant',
|
||
|
|
);
|
||
|
|
CRM_Utils_Recent::del($grantRecent);
|
||
|
|
|
||
|
|
if ($grant->fetch()) {
|
||
|
|
$results = $grant->delete();
|
||
|
|
CRM_Utils_Hook::post('delete', 'Grant', $grant->id, $grant);
|
||
|
|
return $results;
|
||
|
|
}
|
||
|
|
return FALSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Combine all the exportable fields from the lower levels object.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* array of exportable Fields
|
||
|
|
*/
|
||
|
|
public static function &exportableFields() {
|
||
|
|
if (!self::$_exportableFields) {
|
||
|
|
if (!self::$_exportableFields) {
|
||
|
|
self::$_exportableFields = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
$grantFields = array(
|
||
|
|
'grant_status' => array(
|
||
|
|
'title' => ts('Grant Status'),
|
||
|
|
'name' => 'grant_status',
|
||
|
|
'data_type' => CRM_Utils_Type::T_STRING,
|
||
|
|
),
|
||
|
|
'grant_type' => array(
|
||
|
|
'title' => ts('Grant Type'),
|
||
|
|
'name' => 'grant_type',
|
||
|
|
'data_type' => CRM_Utils_Type::T_STRING,
|
||
|
|
),
|
||
|
|
'grant_money_transfer_date' => array(
|
||
|
|
'title' => ts('Grant Money Transfer Date'),
|
||
|
|
'name' => 'grant_money_transfer_date',
|
||
|
|
'data_type' => CRM_Utils_Type::T_DATE,
|
||
|
|
),
|
||
|
|
'grant_amount_requested' => array(
|
||
|
|
'title' => ts('Grant Amount Requested'),
|
||
|
|
'name' => 'grant_amount_requested',
|
||
|
|
'data_type' => CRM_Utils_Type::T_FLOAT,
|
||
|
|
),
|
||
|
|
'grant_application_received_date' => array(
|
||
|
|
'title' => ts('Grant Application Received Date'),
|
||
|
|
'name' => 'grant_application_received_date',
|
||
|
|
'data_type' => CRM_Utils_Type::T_DATE,
|
||
|
|
),
|
||
|
|
);
|
||
|
|
|
||
|
|
$fields = CRM_Grant_DAO_Grant::export();
|
||
|
|
$grantNote = array(
|
||
|
|
'grant_note' => array(
|
||
|
|
'title' => ts('Grant Note'),
|
||
|
|
'name' => 'grant_note',
|
||
|
|
'data_type' => CRM_Utils_Type::T_TEXT,
|
||
|
|
),
|
||
|
|
);
|
||
|
|
$fields = array_merge($fields, $grantFields, $grantNote,
|
||
|
|
CRM_Core_BAO_CustomField::getFieldsForImport('Grant')
|
||
|
|
);
|
||
|
|
self::$_exportableFields = $fields;
|
||
|
|
}
|
||
|
|
|
||
|
|
return self::$_exportableFields;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get grant record count for a Contact.
|
||
|
|
*
|
||
|
|
* @param int $contactID
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
* count of grant records
|
||
|
|
*/
|
||
|
|
public static function getContactGrantCount($contactID) {
|
||
|
|
$query = "SELECT count(*) FROM civicrm_grant WHERE civicrm_grant.contact_id = {$contactID} ";
|
||
|
|
return CRM_Core_DAO::singleValueQuery($query);
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|