Towards CRM-20037 edit template to be more flexible.

[eileenmcnaughton]

This commit changes the way the Selector.tpl is structured to be 'driven' by the array,
meaning that if people alter the order, or the array, their changes are more easily reflected in the tpl.

I've kind of ignored the soft credit fields but this does set a direction for setting them in
and not having special handling in the tpl - ie. replace {if $softCreditColumns}

with columnHeader wrangling

---

• CRM-20037: Change Contribution tab to show balance due

[eileenmcnaughton]

@monishdeb I think this simplifies the changes required & allows the hook to re-order. It's probably worth adding weight - e,.g just before returning from getColumnHeaders

foreach (array_keys($columnHeaders) as $key) {
$columnHeaders[$key]['weight'] = $key *10;
}

and then reordering after the hook. Would be easier for hook users. Hook docs would need updating

[monishdeb]

@eileenmcnaughton thanks for the improvement. Makes sense to introduce weight attribute in columnHeaders , can you update the PR with

foreach (array_keys($columnHeaders) as $key) {
   $columnHeaders[$key]['weight'] = $key *10;
}

[eileenmcnaughton]

@monishdeb see if you can make that work

[monishdeb]

The patch works for me, this is how the hook definition is adjusted

function hook_civicrm_searchColumns($contextName, &$columnHeaders, &$rows, $form) {
  if ($contextName == 'contribution') {
    foreach ($columnHeaders as $index => $column) {
      if ($column['field_name'] == 'total_amount') {
        $weight = $column['weight']+1;
        $columnHeaders[$weight] = array(
          'name' => ts('Balance Due'),
          'field_name' => 'balance_due',
          'weight' => $weight,
        );
        break;
      }
    }

    foreach ($rows as $key => $row) {
      $balanceDue = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType(
        $row['contribution_id'],
        'contribution',
        FALSE,
        $row['total_amount']
      );
      $rows[$key]['balance_due'] = sprintf("<b>%s</b>", CRM_Utils_Money::format($balanceDue));
    }
  }
}