* Class CRM_Report_Form
*/
class CRM_Report_Form extends CRM_Core_Form {
+ /**
+ * Variables smarty expects to have set.
+ *
+ * We ensure these are assigned (value = NULL) when Smarty is instantiated in
+ * order to avoid e-notices / having to use empty or isset in the template layer.
+ *
+ * @var string[]
+ */
+ public $expectedSmartyVariables = ['pager', 'skip', 'sections', 'grandStat'];
+
/**
* Deprecated constant, Reports should be updated to use the getRowCount function.
*/
if ($pager) {
$this->setPager();
}
-
+ $chartEnabled = !empty($this->_params['charts']) && !empty($rows);
+ $this->assign('chartEnabled', $chartEnabled);
// allow building charts if any
- if (!empty($this->_params['charts']) && !empty($rows)) {
+ if ($chartEnabled) {
$this->buildChart($rows);
- $this->assign('chartEnabled', TRUE);
$this->_chartId = "{$this->_params['charts']}_" .
($this->_id ? $this->_id : substr(get_class($this), 16)) . '_' .
CRM_Core_Config::singleton()->userSystem->getSessionId();
if (!empty($value['no_display'])) {
unset($this->_columnHeaders[$key]);
}
+ foreach (['colspan', 'type'] as $expectedKey) {
+ if (!isset($this->_columnHeaders[$key][$expectedKey])) {
+ // Ensure it is set to prevent smarty notices.
+ $this->_columnHeaders[$key][$expectedKey] = FALSE;
+ }
+ }
}
// unset columns not to be displayed.
foreach ($this->_noDisplay as $noDisplayField) {
foreach ($rows as $rowNum => $row) {
unset($this->_columnHeaders[$noDisplayField]);
+ $expectedKeys = ['class'];
+ foreach ($expectedKeys as $expectedKey) {
+ if (!array_key_exists($expectedKey, $row)) {
+ $rows[$rowNum][$expectedKey] = NULL;
+ }
+ }
}
}
}
* @param array $rows
*/
public function doTemplateAssignment(&$rows) {
- $this->assign_by_ref('columnHeaders', $this->_columnHeaders);
+ $this->assign('columnHeaders', $this->_columnHeaders);
$this->assign_by_ref('rows', $rows);
$this->assign('statistics', $this->statistics($rows));
}
$statistics['counts']['rowCount'] = [
'title' => ts('Row(s) Listed'),
'value' => $count,
+ 'type' => CRM_Utils_Type::T_INT,
];
if ($this->_rowsFound && ($this->_rowsFound > $count)) {
$statistics['counts']['rowsFound'] = [
'title' => ts('Total Row(s)'),
'value' => $this->_rowsFound,
+ 'type' => CRM_Utils_Type::T_INT,
];
}
}
'value' => implode(' & ', $combinations),
];
}
+ else {
+ // prevents an e-notice in statistics.tpl.
+ $statistics['groups'] = [];
+ }
}
/**
}
}
}
+ else {
+ // Prevents an e-notice in statistics.tpl.
+ $statistics['filters'] = [];
+ }
}
}
$_REQUEST['reset'] = CRM_Utils_Array::value('reset', $params, 1);
$optionVal = self::getValueFromUrl($instanceId);
- $messages = ["Report Mail Triggered..."];
+ $messages = ['Report Mail Triggered...'];
$templateInfo = CRM_Core_OptionGroup::getRowValues('report_template', $optionVal, 'value');
$obj = new CRM_Report_Page_Instance();
{elseif $section eq 2}
<div class="crm-block crm-content-block crm-report-layoutTable-form-block">
{*include the table layout*}
- {if empty($chartEnabled) || empty($chartSupported)}
+ {if !$chartEnabled || empty($chartSupported)}
{include file="CRM/Report/Form/Layout/Table.tpl"}
{/if}
</div>
{include file="CRM/Report/Form/Actions.tpl"}
{*Statistics at the Top of the page*}
- {include file="CRM/Report/Form/Statistics.tpl" top=true}
+ {include file="CRM/Report/Form/Statistics.tpl" top=true bottom=false}
{*include the graph*}
{include file="CRM/Report/Form/Layout/Graph.tpl"}
{*include the table layout*}
- {if empty($chartEnabled) || empty($chartSupported)}
+ {if !$chartEnabled || empty($chartSupported)}
{include file="CRM/Report/Form/Layout/Table.tpl"}
{/if}
<br />
{*Statistics at the bottom of the page*}
- {include file="CRM/Report/Form/Statistics.tpl" bottom=true}
+ {include file="CRM/Report/Form/Statistics.tpl" top="false" bottom=true}
{include file="CRM/Report/Form/ErrorMessage.tpl"}
</div>
<div class="crm-block crm-content-block crm-report-form-block">
{include file="CRM/Report/Form/Actions.tpl"}
{if !$section }
-{include file="CRM/Report/Form/Statistics.tpl" top=true}
+{include file="CRM/Report/Form/Statistics.tpl" top=true bottom=false}
{/if}
{if $rows}
<div class="report-pager">
{if !$section }
{*Statistics at the bottom of the page*}
- {include file="CRM/Report/Form/Statistics.tpl" bottom=true}
+ {include file="CRM/Report/Form/Statistics.tpl" top="false" bottom=true}
{/if}
{/if}
{include file="CRM/Report/Form/ErrorMessage.tpl"}
{include file="CRM/Report/Form/Actions.tpl"}
{*Statistics at the Top of the page*}
- {include file="CRM/Report/Form/Statistics.tpl" top=true}
-
+ {include file="CRM/Report/Form/Statistics.tpl" top=true bottom=false}
+
<table class="report-layout display">
{foreach from=$rows item=row}
<thead><th colspan=16><font color="black" size="3">{$row.label}</font></th></thead>
-
+
<thead class="sticky">
<tr>
{foreach from=$columnHeaders item=label key=header}
<br />
{*Statistics at the bottom of the page*}
- {include file="CRM/Report/Form/Statistics.tpl" bottom=true}
+ {include file="CRM/Report/Form/Statistics.tpl" top="false" bottom=true}
{include file="CRM/Report/Form/ErrorMessage.tpl"}
</div>
{include file="CRM/Report/Form/Actions.tpl"}
{*Statistics at the Top of the page*}
{if !$section }
- {include file="CRM/Report/Form/Statistics.tpl" top=true}
+ {include file="CRM/Report/Form/Statistics.tpl" top=true bottom=false}
{/if}
{if $events}
</div>
{if !$section }
{*Statistics at the bottom of the page*}
- {include file="CRM/Report/Form/Statistics.tpl" bottom=true}
+ {include file="CRM/Report/Form/Statistics.tpl" top="false" bottom=true}
{/if}
{/if}
{include file="CRM/Report/Form/ErrorMessage.tpl"}
*}
{assign var=uploadURL value=$config->imageUploadURL|replace:'/persist/contribute/':'/persist/'}
{* Display weekly,Quarterly,monthly and yearly contributions using pChart (Bar and Pie) *}
-{if !empty($chartEnabled) and !empty($chartSupported)}
+{if $chartEnabled and !empty($chartSupported)}
<div class='crm-chart'>
{if $outputMode eq 'print' OR $outputMode eq 'pdf'}
<img src="{$uploadURL|cat:$chartId}.png" />
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*}
-{if empty($rows)}
+{if !$rows}
<p>{ts}None found.{/ts}</p>
{else}
- {if !empty($pager) and $pager->_response and $pager->_response.numPages > 1}
+ {if $pager and $pager->_response and $pager->_response.numPages > 1}
<div class="report-pager">
{include file="CRM/common/pager.tpl" location="top"}
</div>
{else}
{assign var=class value="class='reports-header'"}
{/if}
- {if empty($skip)}
- {if !empty($header.colspan)}
+ {if !$skip}
+ {if $header.colspan}
<th colspan={$header.colspan}>{$header.title|escape}</th>
{assign var=skip value=true}
{assign var=skipCount value=`$header.colspan`}
{/foreach}
{/capture}
- {if empty($sections)} {* section headers and sticky headers aren't playing nice yet *}
+ {if !$sections} {* section headers and sticky headers aren't playing nice yet *}
<thead class="sticky">
<tr>
{$tableHeader}
{foreach from=$rows item=row key=rowid}
{eval var=$sectionHeaderTemplate}
- <tr class="{cycle values="odd-row,even-row"} {if !empty($row.class)}{$row.class}{/if} crm-report" id="crm-report_{$rowid}">
+ <tr class="{cycle values="odd-row,even-row"} {if $row.class}{$row.class}{/if} crm-report" id="crm-report_{$rowid}">
{foreach from=$columnHeaders item=header key=field}
{assign var=fieldLink value=$field|cat:"_link"}
{assign var=fieldHover value=$field|cat:"_hover"}
{assign var=fieldClass value=$field|cat:"_class"}
<td class="crm-report-{$field}{if $header.type eq 1024 OR $header.type eq 1 OR $header.type eq 512} report-contents-right{elseif $row.$field eq 'Subtotal'} report-label{/if}">
{if !empty($row.$fieldLink)}
- <a title="{$row.$fieldHover|escape}" href="{$row.$fieldLink}" {if !empty($row.$fieldClass)} class="{$row.$fieldClass}"{/if}>
+ <a title="{$row.$fieldHover|escape}" href="{$row.$fieldLink}" {if array_key_exists($fieldClass, $row)} class="{$row.$fieldClass}"{/if}>
{/if}
{if is_array($row.$field)}
</tr>
{/foreach}
- {if !empty($grandStat)}
+ {if $grandStat}
{* foreach from=$grandStat item=row*}
<tr class="total-row">
{foreach from=$columnHeaders item=header key=field}
{* /foreach*}
{/if}
</table>
- {if !empty($pager) and $pager->_response and $pager->_response.numPages > 1}
+ {if $pager and $pager->_response and $pager->_response.numPages > 1}
<div class="report-pager">
{include file="CRM/common/pager.tpl" location="bottom"}
</div>
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*}
-{if !empty($top)}
+{if $top}
{if !empty($printOnly)}
<h1>{$reportTitle}</h1>
<div id="report-date">{if !empty($reportDate)}{$reportDate}{/if}</div>
{/if}
{if !empty($statistics)}
<table class="report-layout statistics-table">
- {if !empty($statistics.groups)}
- {foreach from=$statistics.groups item=row}
- <tr>
- <th class="statistics" scope="row">{$row.title}</th>
- <td>{$row.value|escape}</td>
- </tr>
- {/foreach}
- {/if}
- {if !empty($statistics.filters)}
- {foreach from=$statistics.filters item=row}
- <tr>
- <th class="statistics" scope="row">{$row.title}</th>
- <td>{$row.value|escape}</td>
- </tr>
- {/foreach}
- {/if}
+ {foreach from=$statistics.groups item=row}
+ <tr>
+ <th class="statistics" scope="row">{$row.title}</th>
+ <td>{$row.value|escape}</td>
+ </tr>
+ {/foreach}
+ {foreach from=$statistics.filters item=row}
+ <tr>
+ <th class="statistics" scope="row">{$row.title}</th>
+ <td>{$row.value|escape}</td>
+ </tr>
+ {/foreach}
</table>
{/if}
{/if}
-{if !empty($bottom) and !empty($rows) and !empty($statistics)}
+{if $bottom and !empty($rows) and !empty($statistics)}
<table class="report-layout">
- {if !empty($statistics.counts)}
+ {if $statistics.counts}
{foreach from=$statistics.counts item=row}
<tr>
<th class="statistics" scope="row">{$row.title}</th>
<td>
- {if !empty($row.type) and $row.type eq 1024}
+ {if $row.type eq 1024}
{$row.value|crmMoney|escape}
- {elseif !empty($row.type) and $row.type eq 2}
+ {elseif $row.type eq 2}
{$row.value|escape}
{else}
{$row.value|crmNumberFormat|escape}
* Make sure the total amount of a contribution doesn't multiply by the number
* of soft credits.
*/
- public function testMultipleSoftCredits() {
+ public function testMultipleSoftCredits(): void {
$this->quickCleanup($this->_tablesToTruncate);
$solParams = [
'first_name' => 'Solicitor 1',
- 'last_name' => 'User ' . rand(),
+ 'last_name' => 'User',
'contact_type' => 'Individual',
];
$solicitor1Id = $this->individualCreate($solParams);
'rowCount' => [
'title' => 'Row(s) Listed',
'value' => 1,
+ 'type' => CRM_Utils_Type::T_INT,
],
'amount' => [
'title' => 'Total Amount (Contributions)',
* tests for that - we're more interested in does it echo it in print
* format.
*/
- public function testOutputPrint() {
+ public function testOutputPrint(): void {
// Create many contacts, in particular so that the report would be more
// than a one-pager.
for ($i = 0; $i < 110; $i++) {
]);
}
catch (CRM_Core_Exception_PrematureExitException $e) {
- $contents = ob_get_contents();
- ob_end_clean();
+ $contents = ob_get_clean();
}
$this->assertStringContainsString('<title>CiviCRM Report</title>', $contents);
$this->assertStringContainsString('test report', $contents);
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
- public function testOutputPdf() {
+ public function testOutputPdf(): void {
+ $contents = '';
// Create many contacts, in particular so that the report would be more
// than a one-pager.
for ($i = 0; $i < 110; $i++) {
]);
}
catch (CRM_Core_Exception_PrematureExitException $e) {
- $contents = ob_get_contents();
- ob_end_clean();
+ $contents = ob_get_clean();
}
$this->assertStringStartsWith('%PDF', $contents);
$this->assertStringContainsString("id_value={$last_contact['id']}", $contents);
/**
* Test when you choose Csv from the actions dropdown.
*/
- public function testOutputCsv() {
+ public function testOutputCsv(): void {
// Create many contacts, in particular so that the report would be more
// than a one-pager.
for ($i = 0; $i < 110; $i++) {
'civicrm_contact_contact_source_link' => '/index.php?q=civicrm/contact/view&reset=1&cid=' . $this->contactIDs[2],
'civicrm_contact_contact_source_hover' => 'View Contact Summary for this Contact',
'civicrm_activity_activity_type_id_hover' => 'View Activity Record',
+ 'class' => NULL,
];
$row = $rows[0];
// This link is not relative - skip for now
projects / civicrm-core.git / commitdiff