https://www.mediawiki.org/wiki/Special:Code/MediaWiki/111960
Revision: 111960
Author: foxtrott
Date: 2012-02-20 20:21:18 +0000 (Mon, 20 Feb 2012)
Log Message:
-----------
new result printers 'tree', 'ultree', 'oltree'
Modified Paths:
--------------
trunk/extensions/SemanticResultFormats/SRF_Messages.php
trunk/extensions/SemanticResultFormats/SRF_Settings.php
trunk/extensions/SemanticResultFormats/SemanticResultFormats.php
Added Paths:
-----------
trunk/extensions/SemanticResultFormats/Tree/
trunk/extensions/SemanticResultFormats/Tree/SRF_Tree.php
Modified: trunk/extensions/SemanticResultFormats/SRF_Messages.php
===================================================================
--- trunk/extensions/SemanticResultFormats/SRF_Messages.php 2012-02-20
20:20:26 UTC (rev 111959)
+++ trunk/extensions/SemanticResultFormats/SRF_Messages.php 2012-02-20
20:21:18 UTC (rev 111960)
@@ -137,11 +137,15 @@
'srf-paramdesc-graph-wwl' => 'Word wrap limit (in # characters)',
'srf-warn-empy-chart' => 'The chart is not shown because there are no
results that can be displayed on it.',
-
+
//DataTables
'srf_printername_datatables' => 'DataTables',
'srf-paramdesc-rowindex' => 'Table row index',
- 'srf-paramdesc-displaylength' => 'Initial display length',
+ 'srf-paramdesc-displaylength' => 'Initial display length',
+
+ // format "tree", "ultree", "oltree"
+ 'srf-noparentprop' => 'No parent property given. The tree can not be
built without a specified parent property.',
+ 'srf-paramdesc-parent' => 'The property containing the parent page',
);
/** Message documentation (Message documentation)
@@ -184,6 +188,8 @@
'srf_printername_gallery' => '{{Identical|Gallery}}',
'srf_paramdesc_headersep' => 'Do not translate "headers" since it is
the name of a parameter. "show" and "plain" should not be translated either
since these are setting options for this parameter.',
'srf_paramdesc_graphname' => '{{Identical|Title}}',
+ 'srf-noparentprop' => 'No parent property given. The tree can not be
built without a specified parent property.',
+ 'srf-paramdesc-parent' => '{{doc-paramdesc|parent}}',
);
/** Afrikaans (Afrikaans)
Modified: trunk/extensions/SemanticResultFormats/SRF_Settings.php
===================================================================
--- trunk/extensions/SemanticResultFormats/SRF_Settings.php 2012-02-20
20:20:26 UTC (rev 111959)
+++ trunk/extensions/SemanticResultFormats/SRF_Settings.php 2012-02-20
20:21:18 UTC (rev 111960)
@@ -44,6 +44,9 @@
'tagcloud',
'valuerank',
'array',
+ 'tree',
+ 'ultree',
+ 'oltree',
);
if ( defined( 'MW_SUPPORTS_RESOURCE_MODULES' ) ) {
Modified: trunk/extensions/SemanticResultFormats/SemanticResultFormats.php
===================================================================
--- trunk/extensions/SemanticResultFormats/SemanticResultFormats.php
2012-02-20 20:20:26 UTC (rev 111959)
+++ trunk/extensions/SemanticResultFormats/SemanticResultFormats.php
2012-02-20 20:21:18 UTC (rev 111960)
@@ -97,6 +97,7 @@
$wgAutoloadClasses['SRFD3Line'] = $formatDir . 'D3/SRF_D3Line.php';
$wgAutoloadClasses['SRFD3Bar'] = $formatDir . 'D3/SRF_D3Bar.php';
$wgAutoloadClasses['SRFD3Treemap'] = $formatDir . 'D3/SRF_D3Treemap.php';
+$wgAutoloadClasses['SRFTree'] = $formatDir . 'Tree/SRF_Tree.php';
unset( $formatDir );
@@ -145,6 +146,9 @@
'D3Line' => 'SRFD3Line',
'D3Bar' => 'SRFD3Bar',
'D3Treemap' => 'SRFD3Treemap',
+ 'tree' => 'SRFTree',
+ 'ultree' => 'SRFTree',
+ 'oltree' => 'SRFTree',
);
$formatAliases = array(
Added: trunk/extensions/SemanticResultFormats/Tree/SRF_Tree.php
===================================================================
--- trunk/extensions/SemanticResultFormats/Tree/SRF_Tree.php
(rev 0)
+++ trunk/extensions/SemanticResultFormats/Tree/SRF_Tree.php 2012-02-20
20:21:18 UTC (rev 111960)
@@ -0,0 +1,252 @@
+<?php
+
+/**
+ * File holding the SRFTree class.
+ *
+ * @file
+ * @ingroup SemanticResultFormats
+ * @author Stephan Gambke
+ *
+ */
+
+/**
+ * Result printer that prints query results as a tree (nested html lists).
+ *
+ * The available formats are 'tree', 'ultree', 'oltree'. 'tree' is an alias of
+ * 'ultree'. In an #ask query the parameter 'parent' must be set to contain the
+ * name of the property, that gives the parent page of the subject page.
+ *
+ */
+class SRFTree extends SMWListResultPrinter {
+
+ protected $mTreeProp = null;
+
+ protected function handleParameters( array $params, $outputmode ) {
+ parent::handleParameters( $params, $outputmode );
+
+ //// Set in SMWResultPrinter:
+ // $this->mIntro = $params['intro'];
+ // $this->mOutro = $params['outro'];
+ // $this->mSearchlabel = $params['searchlabel'] === false ?
null : $params['searchlabel'];
+ // $this->mLinkFirst = true | false;
+ // $this->mLinkOthers = true | false;
+ // $this->mDefault = str_replace( '_', ' ', $params['default']
);
+ // $this->mShowHeaders = SMW_HEADERS_HIDE | SMW_HEADERS_PLAIN |
SMW_HEADERS_SHOW;
+ //// Set in SMWListResultPrinter:
+ // $this->mSep = $this->isPlainlist() ? $params['sep'] : '';
+ // $this->mTemplate = trim( $params['template'] );
+ // $this->mNamedArgs = $params['named args'];
+ // $this->mUserParam = trim( $params['userparam'] );
+ // $this->mColumns = !$this->isPlainlist() ? $params['columns']
: 1;
+ // $this->mIntroTemplate = $params['introtemplate'];
+ // $this->mOutroTemplate = $params['outrotemplate'];
+ // Don't support pagination in trees
+ $this->mSearchlabel = null;
+
+ // Trees are always ul or ol, never plainlists
+ $this->mSep = '';
+
+ // Trees support only one column
+ $this->mColumns = 1;
+
+ if ( array_key_exists( 'parent', $params ) ) {
+ $this->mTreeProp = $params['parent'];
+ }
+ }
+
+ /**
+ * Return serialised results in specified format.
+ */
+ protected function getResultText( SMWQueryResult $res, $outputmode ) {
+
+ if ( $this->mTreeProp === null ) {
+ $res->addErrors( array( wfMsgForContent(
'srf-noparentprop' ) ) );
+ return '';
+ }
+
+ $store = $res->getStore();
+
+
+ // first put everything in a list
+ // elements appearing more than once will be inserted more than
once,
+ // but only one instance will be inserted with the hash
+ // only this instance will be considered as a parent element in
the tree
+ $list = array( );
+
+ while ( $row = $res->getNext() ) {
+
+ $hash = $row[0]->getResultSubject()->getSerialization();
+
+ if ( array_key_exists( $hash, $list ) ) {
+ $list[] = new SRFTreeElement( $row );
+ } else {
+ $list[$hash] = new SRFTreeElement( $row );
+ }
+ }
+
+ // transfer the listelements into the tree
+ // elements with more than one parent will be cloned for each
parent
+ $tree = array( );
+
+ foreach ( $list as $hash => $listElem ) {
+
+ $parents = $store->getPropertyValues(
+ $listElem->mRow[0]->getResultSubject(),
+
SMWDIProperty::newFromUserLabel($this->mTreeProp)
+ );
+
+ // transfer element from list to tree
+ foreach ( $parents as $parent ) {
+ $parentPageHash = $parent->getSerialization();
+
+ if ( $hash !== null ) {
+
+ if ( array_key_exists( $parentPageHash,
$list ) ) {
+ $listElem->mParent =
$parentPageHash;
+ }
+
+ $tree[$hash] = $listElem;
+ $hash = null;
+ } else {
+ $treeElem = clone $listElem;
+
+ if ( array_key_exists( $parentPageHash,
$list ) ) {
+ $treeElem->mParent =
$parentPageHash;
+ } else {
+ $treeElem->mParent = null;
+ }
+
+ $tree[] = $treeElem;
+ }
+ }
+ }
+
+
+ foreach ( $tree as $hash => $value ) {
+
+ }
+ // build pointers from parants to children
+ foreach ( $tree as $hash => $treeElem ) {
+
+ if ( $treeElem->mParent != null ) {
+ $tree[$treeElem->mParent]->mChildren[] =
$treeElem;
+ }
+ }
+
+ // remove children from toplevel
+ foreach ( $tree as $hash => $treeElem ) {
+
+ if ( $treeElem->mParent != null ) {
+ unset ($tree[$hash]);
+ }
+ }
+
+ $result = '';
+ $rownum = 0;
+
+ foreach ( $tree as $hash => $treeElem ) {
+
+ $this->printElement( $result, $treeElem, $row );
+ }
+
+ return $result;
+ }
+
+ protected function printElement( &$result, SRFTreeElement &$element,
&$rownum, $level = 1 ) {
+
+ $rownum++;
+
+ $result .= str_pad( '', $level, ($this->mFormat ==
'oltree')?'#':'*' );
+
+ if ( $this->mTemplate !== '' ) { // build template code
+ $this->hasTemplates = true;
+ $wikitext = ( $this->mUserParam ) ?
"|userparam=$this->mUserParam" : '';
+
+ foreach ( $element->mRow as $i => $field ) {
+ $wikitext .= '|' . ( $this->mNamedArgs ? '?' .
$field->getPrintRequest()->getLabel() : $i + 1 ) . '=';
+ $first_value = true;
+
+ while ( ( $text = $field->getNextText(
SMW_OUTPUT_WIKI,
+ $this->getLinker( $i == 0 ) ) ) !== false ) {
+
+ if ( $first_value ) {
+ $first_value = false;
+ } else {
+ $wikitext .= ', ';
+ }
+ $wikitext .= $text;
+ }
+ }
+
+ $wikitext .= "|#=$rownum";
+ $result .= '{{' . $this->mTemplate . $wikitext . '}}';
+ // str_replace('|', '|', // encode '|' for use
in templates (templates fail otherwise) -- this is not the place for doing
this, since even DV-Wikitexts contain proper "|"!
+ } else { // build simple list
+ $first_col = true;
+ $found_values = false; // has anything but the first
column been printed?
+
+ foreach ( $element->mRow as $field ) {
+ $first_value = true;
+
+ $field->reset();
+
+ while ( ( $text = $field->getNextText(
SMW_OUTPUT_WIKI, $this->getLinker( $first_col ) ) ) !== false ) {
+
+ if ( !$first_col && !$found_values ) {
// first values after first column
+ $result .= ' (';
+ $found_values = true;
+ }
+
+ if ( $first_value ) { // first value in
any column, print header
+ $first_value = false;
+
+ if ( ( $this->mShowHeaders !=
SMW_HEADERS_HIDE ) &&
+ (
$field->getPrintRequest()->getLabel() !== '' ) ) {
+ $result .=
$field->getPrintRequest()->getText( SMW_OUTPUT_WIKI, ( $this->mShowHeaders ==
SMW_HEADERS_PLAIN ? null:$this->mLinker ) ) . ' ';
+ }
+ }
+
+ $result .= $text; // actual output value
+
+ }
+
+ $first_col = false;
+ }
+
+ if ( $found_values ) $result .= ')';
+ }
+
+ $result .= "\n";
+
+ foreach ( $element->mChildren as $hash => $treeElem ) {
+
+ $this->printElement($result, $treeElem, $rownum, $level
+ 1);
+ }
+ }
+
+
+ public function getParameters() {
+ $params = array_merge( parent::getParameters(),
+ parent::textDisplayParameters() );
+
+ $params['parent'] = new Parameter( 'parent' );
+ $params['parent']->setMessage( 'srf-paramdesc-parent' );
+ $params['parent']->setDefault( '' );
+
+ return $params;
+ }
+
+}
+
+class SRFTreeElement {
+
+ var $mChildren = array( );
+ var $mParent = null;
+ var $mRow = null;
+
+ public function __construct( &$row ) {
+ $this->mRow = $row;
+ }
+
+}
+
Property changes on: trunk/extensions/SemanticResultFormats/Tree/SRF_Tree.php
___________________________________________________________________
Added: svn:eol-style
+ native
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
