mode, \helper_plugin_struct::BLACKLIST_RENDERER)) return;
// abort early if there are no results at all (not filtered)
if ($this->searchConfig->getCount() <= 0 && !$this->isDynamicallyFiltered() && $showNotFound) {
$this->renderer->cdata($this->helper->getLang('none'));
return;
}
$this->renderActiveFilters();
$rendercontext = [
'table' => $this,
'renderer' => $this->renderer,
'format' => $this->mode,
'search' => $this->searchConfig,
'columns' => $this->columns,
'data' => $this->searchConfig->getRows()
];
$event = new Event(
'PLUGIN_STRUCT_RENDER_AGGREGATION_TABLE',
$rendercontext
);
$event->trigger([$this, 'renderTable']);
// export handle
$this->renderExportControls();
}
/**
* Render the default aggregation table
*/
public function renderTable($rendercontext)
{
$this->renderer->table_open();
// header
$this->renderer->tablethead_open();
$this->renderColumnHeaders();
$this->renderDynamicFilters();
$this->renderer->tablethead_close();
if ($this->searchConfig->getCount()) {
// actual data
$this->renderer->tabletbody_open();
$this->renderResult();
$this->renderer->tabletbody_close();
// footer (tfoot is develonly currently)
if (method_exists($this->renderer, 'tabletfoot_open')) $this->renderer->tabletfoot_open();
$this->renderSums();
$this->renderPagingControls();
if (method_exists($this->renderer, 'tabletfoot_close')) $this->renderer->tabletfoot_close();
} else {
// nothing found
$this->renderEmptyResult();
}
// table close
$this->renderer->table_close();
}
/**
* Adds additional info to document and renderer in XHTML mode
*
* @see finishScope()
*/
public function startScope()
{
// unique identifier for this aggregation
$this->renderer->info['struct_table_hash'] = md5(var_export($this->data, true));
parent::startScope();
}
/**
* Closes the table and anything opened in startScope()
*
* @see startScope()
*/
public function finishScope()
{
// remove identifier from renderer again
if (isset($this->renderer->info['struct_table_hash'])) {
unset($this->renderer->info['struct_table_hash']);
}
parent::finishScope();
}
/**
* Displays info about the currently applied filters
*/
protected function renderActiveFilters()
{
if ($this->mode != 'xhtml') return;
$dynamic = $this->searchConfig->getDynamicParameters();
$filters = $dynamic->getFilters();
if (!$filters) return;
$fltrs = [];
foreach ($filters as $column => $filter) {
[$comp, $value] = $filter;
// display the filters in a human readable format
foreach ($this->columns as $col) {
if ($column === $col->getFullQualifiedLabel()) {
$column = $col->getTranslatedLabel();
}
}
$fltrs[] = sprintf('"%s" %s "%s"', $column, $this->helper->getLang("comparator $comp"), $value);
}
$this->renderer->doc .= '
';
$this->renderer->doc .= '
' .
sprintf(
$this->helper->getLang('tablefilteredby'),
hsc(implode(' & ', $fltrs))
) .
'
';
$this->renderer->doc .= '
';
$this->renderer->internallink($this->id, $this->helper->getLang('tableresetfilter'));
$this->renderer->doc .= '
';
$this->renderer->doc .= '
';
}
/**
* Shows the column headers with links to sort by column
*/
protected function renderColumnHeaders()
{
$this->renderer->tablerow_open();
// additional column for row numbers
if (!empty($this->data['rownumbers'])) {
$this->renderer->tableheader_open();
$this->renderer->cdata('#');
$this->renderer->tableheader_close();
}
// show all headers
foreach ($this->columns as $num => $column) {
$header = '';
if (isset($this->data['headers'][$num])) {
$header = $this->data['headers'][$num];
}
// use field label if no header was set
if (blank($header)) {
if (is_a($column, 'dokuwiki\plugin\struct\meta\Column')) {
$header = $column->getTranslatedLabel();
} else {
$header = 'column ' . $num; // this should never happen
}
}
// simple mode first
if ($this->mode != 'xhtml') {
$this->renderer->tableheader_open();
$this->renderer->cdata($header);
$this->renderer->tableheader_close();
continue;
}
// still here? create custom header for more flexibility
// width setting, widths are prevalidated, no escape needed
$width = '';
if (isset($this->data['widths'][$num]) && $this->data['widths'][$num] != '-') {
$width = ' style="min-width: ' . $this->data['widths'][$num] . ';' .
'max-width: ' . $this->data['widths'][$num] . ';"';
}
// prepare data attribute for inline edits
if (
!is_a($column, '\dokuwiki\plugin\struct\meta\PageColumn') &&
!is_a($column, '\dokuwiki\plugin\struct\meta\RevisionColumn')
) {
$data = 'data-field="' . hsc($column->getFullQualifiedLabel()) . '"';
} else {
$data = '';
}
// sort indicator and link
$sortclass = '';
$sorts = $this->searchConfig->getSorts();
$dynamic = $this->searchConfig->getDynamicParameters();
$dynamic->setSort($column, true);
if (isset($sorts[$column->getFullQualifiedLabel()])) {
[/*colname*/, $currentSort] = $sorts[$column->getFullQualifiedLabel()];
if ($currentSort) {
$sortclass = 'sort-down';
$dynamic->setSort($column, false);
} else {
$sortclass = 'sort-up';
}
}
$link = wl($this->id, $dynamic->getURLParameters());
// output XHTML header
$this->renderer->doc .= "";
if (is_a($this->renderer, 'renderer_plugin_dw2pdf')) {
$this->renderer->doc .= hsc($header);
} else {
$this->renderer->doc .= 'helper->getLang('sort') . '">' . hsc($header) . '';
}
$this->renderer->doc .= ' | ';
}
$this->renderer->tablerow_close();
}
/**
* Is the result set currently dynamically filtered?
* @return bool
*/
protected function isDynamicallyFiltered()
{
if ($this->mode != 'xhtml') return false;
if (!$this->data['dynfilters']) return false;
$dynamic = $this->searchConfig->getDynamicParameters();
return (bool)$dynamic->getFilters();
}
/**
* Add input fields for dynamic filtering
*/
protected function renderDynamicFilters()
{
if ($this->mode != 'xhtml') return;
if (empty($this->data['dynfilters'])) return;
if (is_a($this->renderer, 'renderer_plugin_dw2pdf')) {
return;
}
global $conf;
$this->renderer->doc .= '';
// add extra column for row numbers
if ($this->data['rownumbers']) {
$this->renderer->doc .= ' | ';
}
// each column gets a form
foreach ($this->columns as $column) {
$this->renderer->doc .= '';
// BEGIN FORM
$form = new \Doku_Form(
[
'method' => 'GET',
'action' => wl($this->id, $this->renderer->info['struct_table_hash'], false, '#')
]
);
unset($form->_hidden['sectok']); // we don't need it here
if (!$conf['userewrite']) $form->addHidden('id', $this->id);
// current value
$dynamic = $this->searchConfig->getDynamicParameters();
$filters = $dynamic->getFilters();
if (isset($filters[$column->getFullQualifiedLabel()])) {
[, $current] = $filters[$column->getFullQualifiedLabel()];
$dynamic->removeFilter($column);
} else {
$current = '';
}
// Add current request params
$params = $dynamic->getURLParameters();
foreach ($params as $key => $val) {
$form->addHidden($key, $val);
}
// add input field
$key = $column->getFullQualifiedLabel() . $column->getType()->getDefaultComparator();
$form->addElement(
form_makeField('text', SearchConfigParameters::$PARAM_FILTER . '[' . $key . ']', $current, '')
);
$this->renderer->doc .= $form->getForm();
// END FORM
$this->renderer->doc .= ' | ';
}
$this->renderer->doc .= '
';
}
/**
* Display the actual table data
*/
protected function renderResult()
{
foreach ($this->searchConfig->getRows() as $rownum => $row) {
$data = [
'id' => $this->id,
'mode' => $this->mode,
'renderer' => $this->renderer,
'searchConfig' => $this->searchConfig,
'data' => $this->data,
'rownum' => &$rownum,
'row' => &$row
];
$evt = new Event('PLUGIN_STRUCT_AGGREGATIONTABLE_RENDERRESULTROW', $data);
if ($evt->advise_before()) {
$this->renderResultRow($rownum, $row);
}
$evt->advise_after();
}
}
/**
* Render a single result row
*
* @param int $rownum
* @param array $row
*/
protected function renderResultRow($rownum, $row)
{
$this->renderer->tablerow_open();
// add data attribute for inline edit
if ($this->mode == 'xhtml') {
$pid = $this->searchConfig->getPids()[$rownum];
$rid = $this->searchConfig->getRids()[$rownum];
$rev = $this->searchConfig->getRevs()[$rownum];
$this->renderer->doc = substr(rtrim($this->renderer->doc), 0, -1); // remove closing '>'
$this->renderer->doc .= ' data-pid="' . hsc($pid) . '" data-rev="' . $rev . '" data-rid="' . $rid . '">';
}
// row number column
if (!empty($this->data['rownumbers'])) {
$this->renderer->tablecell_open();
$this->renderer->cdata($rownum + $this->searchConfig->getOffset() + 1);
$this->renderer->tablecell_close();
}
/** @var Value $value */
foreach ($row as $colnum => $value) {
$align = $this->data['align'][$colnum] ?? null;
$this->renderer->tablecell_open(1, $align);
$value->render($this->renderer, $this->mode);
$this->renderer->tablecell_close();
// summarize
if (!empty($this->data['summarize']) && is_numeric($value->getValue())) {
if (!isset($this->sums[$colnum])) {
$this->sums[$colnum] = 0;
}
$this->sums[$colnum] += $value->getValue();
}
}
$this->renderer->tablerow_close();
}
/**
* Renders an information row for when no results were found
*/
protected function renderEmptyResult()
{
$this->renderer->tablerow_open();
$this->renderer->tablecell_open(count($this->columns) + $this->data['rownumbers'], 'center');
$this->renderer->cdata($this->helper->getLang('none'));
$this->renderer->tablecell_close();
$this->renderer->tablerow_close();
}
/**
* Add sums if wanted
*/
protected function renderSums()
{
if (empty($this->data['summarize'])) return;
$this->renderer->info['struct_table_meta'] = true;
if ($this->mode == 'xhtml') {
$this->renderer->tablerow_open('summarize');
} else {
$this->renderer->tablerow_open();
}
if ($this->data['rownumbers']) {
$this->renderer->tableheader_open();
$this->renderer->tableheader_close();
}
$len = count($this->columns);
for ($i = 0; $i < $len; $i++) {
$this->renderer->tableheader_open(1, $this->data['align'][$i]);
if (!empty($this->sums[$i])) {
$this->renderer->cdata('∑ ');
$this->columns[$i]->getType()->renderValue($this->sums[$i], $this->renderer, $this->mode);
} elseif ($this->mode == 'xhtml') {
$this->renderer->doc .= ' ';
}
$this->renderer->tableheader_close();
}
$this->renderer->tablerow_close();
$this->renderer->info['struct_table_meta'] = false;
}
/**
* Adds paging controls to the table
*/
protected function renderPagingControls()
{
if ($this->mode != 'xhtml') return;
$limit = $this->searchConfig->getLimit();
if (!$limit) return;
$offset = $this->searchConfig->getOffset();
$this->renderer->info['struct_table_meta'] = true;
$this->renderer->tablerow_open();
$this->renderer->tableheader_open((count($this->columns) + ($this->data['rownumbers'] ? 1 : 0)));
// prev link
if ($offset) {
$prev = $offset - $limit;
if ($prev < 0) {
$prev = 0;
}
$dynamic = $this->searchConfig->getDynamicParameters();
$dynamic->setOffset($prev);
$link = wl($this->id, $dynamic->getURLParameters());
$this->renderer->doc .= '' . $this->helper->getLang('prev') . '';
}
// next link
if ($this->searchConfig->getCount() > $offset + $limit) {
$next = $offset + $limit;
$dynamic = $this->searchConfig->getDynamicParameters();
$dynamic->setOffset($next);
$link = wl($this->id, $dynamic->getURLParameters());
$this->renderer->doc .= '' . $this->helper->getLang('next') . '';
}
$this->renderer->tableheader_close();
$this->renderer->tablerow_close();
$this->renderer->info['struct_table_meta'] = true;
}
/**
* Adds CSV export controls
*/
protected function renderExportControls()
{
if ($this->mode != 'xhtml') return;
if (empty($this->data['csv'])) return;
if (!$this->searchConfig->getCount()) return;
$dynamic = $this->searchConfig->getDynamicParameters();
$params = $dynamic->getURLParameters();
$params['hash'] = $this->renderer->info['struct_table_hash'];
// FIXME apply dynamic filters
$link = exportlink($this->id, 'struct_csv', $params);
$this->renderer->doc .= '' .
$this->helper->getLang('csvexport') . '';
}
}