id = $id; $this->mode = $mode; $this->renderer = $renderer; $this->searchConfig = $searchConfig; $this->data = $searchConfig->getConf(); $this->columns = $searchConfig->getColumns(); $this->result = $this->searchConfig->execute(); $this->resultCount = $this->searchConfig->getCount(); $this->resultPIDs = $this->searchConfig->getPids(); $this->helper = plugin_load('helper', 'struct_config'); } /** * Create the table on the renderer */ public function render() { // abort early if there are no results at all (not filtered) if(!$this->resultCount && !$this->isDynamicallyFiltered() && $this->simplenone) { $this->startScope(); $this->renderer->cdata($this->helper->getLang('none')); $this->finishScope(); return; } // table open $this->startScope(); $this->renderActiveFilters(); $this->renderer->table_open(); // header $this->renderer->tablethead_open(); $this->renderColumnHeaders(); $this->renderDynamicFilters(); $this->renderer->tablethead_close(); if($this->resultCount) { // actual data $this->renderResult(); // footer $this->renderSums(); $this->renderPagingControls(); } else { // nothing found $this->renderEmptyResult(); } // table close $this->renderer->table_close(); // export handle $this->renderExportControls(); $this->finishScope(); } /** * Adds additional info to document and renderer in XHTML mode * * @see finishScope() */ protected function startScope() { // unique identifier for this aggregation $this->renderer->info['struct_table_hash'] = md5(var_export($this->data, true)); // wrapping div if($this->mode != 'xhtml') return; $this->renderer->doc .= "
"; } /** * Closes the table and anything opened in startScope() * * @see startScope() */ protected function finishScope() { // remove identifier from renderer again if(isset($this->renderer->info['struct_table_hash'])) { unset($this->renderer->info['struct_table_hash']); } // wrapping div if($this->mode != 'xhtml') return; $this->renderer->doc .= '
'; } /** * 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 = array(); foreach($filters as $column => $filter) { list($comp, $value) = $filter; $fltrs[] = $column . ' ' . $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($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 $width = ''; if(isset($data['widths'][$num]) && $data['widths'][$num] != '-') { $width = ' style="width: ' . $data['widths'][$num] . ';"'; // widths are prevalidated, no escape needed } // 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()])) { list(/*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 .= ""; $this->renderer->doc .= '' . 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(!$this->data['dynfilters']) return; global $conf, $ACT; if ($ACT == 'export_pdf') { return; } $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 .= ''; { $form = new \Doku_Form(array('method' => 'GET', 'action' => wl($this->id))); 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()])) { list(, $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() . '*~'; $form->addElement(form_makeField('text', SearchConfigParameters::$PARAM_FILTER . '[' . $key . ']', $current, '')); $this->renderer->doc .= $form->getForm(); } $this->renderer->doc .= ''; } $this->renderer->doc .= ''; } /** * Display the actual table data */ protected function renderResult() { $this->renderer->tabletbody_open(); foreach($this->result as $rownum => $row) { $this->renderResultRow($rownum, $row); } $this->renderer->tabletbody_close(); } /** * 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->resultPIDs[$rownum]; $this->renderer->doc = substr(rtrim($this->renderer->doc), 0, -1); // remove closing '>' $this->renderer->doc .= ' data-pid="' . hsc($pid) . '">'; } // row number column if($this->data['rownumbers']) { $this->renderer->tablecell_open(); $this->renderer->cdata($rownum + 1); $this->renderer->tablecell_close(); } /** @var Value $value */ foreach($row as $colnum => $value) { $this->renderer->tablecell_open(); $value->render($this->renderer, $this->mode); $this->renderer->tablecell_close(); // summarize if($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; $this->renderer->tablerow_open(); if($this->data['rownumbers']) { $this->renderer->tablecell_open(); $this->renderer->tablecell_close(); } $len = count($this->columns); for($i = 0; $i < $len; $i++) { $this->renderer->tablecell_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); } else { if($this->mode == 'xhtml') { $this->renderer->doc .= ' '; } } $this->renderer->tablecell_close(); } $this->renderer->tablerow_close(); $this->renderer->info['struct_table_meta'] = false; } /** * Adds paging controls to the table */ protected function renderPagingControls() { if(empty($this->data['limit'])) return; if($this->mode != 'xhtml') return; $this->renderer->info['struct_table_meta'] = true; $this->renderer->tablerow_open(); $this->renderer->tableheader_open((count($this->data['cols']) + ($this->data['rownumbers'] ? 1 : 0))); $offset = $this->data['offset']; // prev link if($offset) { $prev = $offset - $this->data['limit']; if($prev < 0) { $prev = 0; } $dynamic = $this->searchConfig->getDynamicParameters(); $dynamic->setOffset($prev); $link = wl($this->id, $dynamic->getURLParameters()); $this->renderer->doc .= ''; } // next link if($this->resultCount > $offset + $this->data['limit']) { $next = $offset + $this->data['limit']; $dynamic = $this->searchConfig->getDynamicParameters(); $dynamic->setOffset($next); $link = wl($this->id, $dynamic->getURLParameters()); $this->renderer->doc .= ''; } $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->resultCount) 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').''; } }