/**
* Contribution.Earmark is a specific API for MAF Norge
* Expected to run only once it will update the earmarking of any individual contributions that:
* - have status Pending
* - originate from a recurring contribution
* - have a date in the future
* - have an earmarking that is different from the earmarking of the recurring contribution
* and it will update the earmarking to the earmarking of the recurring contribution
*
* @author Erik Hommel (CiviCooP) <*****@*****.**>
* @param array $params
* @return array API result descriptor
* @see civicrm_api3_create_success
* @see civicrm_api3_create_error
* @throws API_Exception
*/
function civicrm_api3_contribution_earmark($params)
{
$countUpdated = 0;
$netsCustomGroup = CRM_Earmarking_Earmarking::getNetsTransactionsTable();
$earmarkingColumn = CRM_Earmarking_Earmarking::getEarmarkingColumn();
$contributionQuery = 'SELECT contr.id AS contribution_id, recur.earmarking_id
FROM civicrm_contribution contr
LEFT JOIN ' . $netsCustomGroup['table_name'] . ' nets ON contr.id = nets.entity_id
LEFT JOIN civicrm_contribution_recur_offline recur ON contr.contribution_recur_id = recur.recur_id
WHERE contr.contribution_recur_id IS NOT NULL
AND contr.contribution_status_id = %1
AND contr.receive_date >= NOW()
AND nets.' . $earmarkingColumn . ' != recur.earmarking_id';
$contributionParams = array(1 => array(2, 'Integer'));
$dao = CRM_Core_DAO::executeQuery($contributionQuery, $contributionParams);
while ($dao->fetch()) {
$netsUpdate = 'UPDATE ' . $netsCustomGroup['table_name'] . ' SET ' . $earmarkingColumn . ' = %1 WHERE entity_id = %2';
$netsParams = array(1 => array($dao->earmarking_id, 'Integer'), 2 => array($dao->contribution_id, 'Integer'));
CRM_Core_DAO::executeQuery($netsUpdate, $netsParams);
$countUpdated++;
}
$returnValues = array('is_error' => 0, 'message' => 'Earmarking of, ' . $countUpdated . ' contributions updated.');
return civicrm_api3_create_success($returnValues, $params, 'Contribution', 'Earmark');
}
/**
* Modify the content of each row
*
* @param array $row modifiable SQL result row
* @throws exception if function getOptionGroup not found
* @return void
*/
function alterRow(&$row)
{
$row['earmarking'] = CRM_Earmarking_Earmarking::getRecurringEarmarkingForContact($row['contact_id']);
$row['contribution_count'] = $this->getRecurringCountForContact($row['contact_id']);
$row['payment_type'] = $this->getPaymentTypesForContact($row['contact_id']);
}
/**
* Implementation of hook civicrm_post to add default earmarking to new contributions
*
* @param string $op
* @param string $objectName
* @param int $objectId
* @param object $objectRef
*/
function earmarking_civicrm_post($op, $objectName, $objectId, &$objectRef)
{
/*
* BOS1506293 if contribution created from recurring, default to earmarking of recurring
*/
if ($objectName == 'Contribution' && $op == 'create') {
if (!empty($objectRef->contribution_recur_id)) {
$earmarkingId = CRM_Earmarking_Earmarking::getRecurringEarmarking($objectRef->contribution_recur_id);
if ($earmarkingId) {
CRM_Earmarking_Earmarking::addContributionEarmark($objectId, $earmarkingId);
}
}
}
}
