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