Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * CiviCRM's Smarty report section totals plugin | |
30 | * | |
16b10e64 | 31 | * Prints the correct report section total based on the given key and order in the section hierarchy |
6a488035 TO |
32 | * |
33 | * @package CRM | |
34 | * @author Allen Shaw <allen@nswebsolutions.com> | |
8c9251b3 | 35 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
36 | * $Id$ |
37 | */ | |
38 | ||
39 | /** | |
16b10e64 | 40 | * Smarty block function for printing the correct report section total |
6a488035 | 41 | * |
6a488035 TO |
42 | * Smarty param: string $key value of the current section column |
43 | * Smarty param: int $depth the depth of the current section | |
44 | * (sections declared first have lesser depth, starting at 0) | |
45 | * | |
6a0b768e TO |
46 | * @param array $params |
47 | * Template call's parameters. | |
16b10e64 | 48 | * @param CRM_Core_Smarty $smarty |
6a0b768e | 49 | * The Smarty object. |
6a488035 | 50 | * |
a6c01b45 | 51 | * @return string |
353ffa53 | 52 | * the string, translated by gettext |
6a488035 TO |
53 | */ |
54 | function smarty_function_sectionTotal($params, &$smarty) { | |
55 | /* section totals are stored in template variable 'sectionTotals', | |
16b10e64 CW |
56 | * which is a two-dimensional array keyed to a string which is a delimited |
57 | * concatenation (using CRM_Core_DAO::VALUE_SEPARATOR) of ordered permutations | |
58 | * of section header values, e.g., | |
59 | * 'foo' => 10, | |
60 | * 'foo[VALUE_SEAPARATOR]bar' => 5, | |
61 | * 'foo[VALUE_SEAPARATOR]bar2' => 5 | |
62 | * Note: This array is created and assigned to the template in CRM_Report_Form::sectionTotals() | |
63 | */ | |
6a488035 TO |
64 | |
65 | static $sectionValues = array(); | |
66 | ||
67 | // move back in the stack, if necessary | |
68 | if (count($sectionValues) > $params['depth']) { | |
69 | $sectionValues = array_slice($sectionValues, 0, $params['depth']); | |
70 | } | |
71 | ||
72 | // append the current value | |
73 | $sectionValues[] = $params['key']; | |
74 | ||
75 | // concatenate with pipes to build the right key | |
76 | $totalsKey = implode(CRM_Core_DAO::VALUE_SEPARATOR, $sectionValues); | |
77 | ||
6a488035 TO |
78 | // return the corresponding total |
79 | return $smarty->_tpl_vars['sectionTotals'][$totalsKey]; | |
80 | } |