https://www.mediawiki.org/wiki/Special:Code/MediaWiki/103398
Revision: 103398
Author: yaron
Date: 2011-11-16 22:27:01 +0000 (Wed, 16 Nov 2011)
Log Message:
-----------
Changed name of class from 'SMWDistributablePrinter' to
'SMWAggregatablePrinter' - this word, though a little more obscure, is a much
more accurate description
Modified Paths:
--------------
trunk/extensions/SemanticMediaWiki/includes/SMW_Setup.php
Added Paths:
-----------
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Aggregatable.php
Removed Paths:
-------------
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Distributable.php
Modified: trunk/extensions/SemanticMediaWiki/includes/SMW_Setup.php
===================================================================
--- trunk/extensions/SemanticMediaWiki/includes/SMW_Setup.php 2011-11-16
22:24:36 UTC (rev 103397)
+++ trunk/extensions/SemanticMediaWiki/includes/SMW_Setup.php 2011-11-16
22:27:01 UTC (rev 103398)
@@ -199,7 +199,7 @@
// Printers
$qpDir = $smwgIP . 'includes/queryprinters/';
$wgAutoloadClasses['SMWResultPrinter'] = $qpDir .
'SMW_QueryPrinter.php';
- $wgAutoloadClasses['SMWDistributablePrinter'] = $qpDir .
'SMW_QP_Distributable.php';
+ $wgAutoloadClasses['SMWAggregatablePrinter'] = $qpDir .
'SMW_QP_Aggregatable.php';
$wgAutoloadClasses['SMWTableResultPrinter'] = $qpDir .
'SMW_QP_Table.php';
$wgAutoloadClasses['SMWListResultPrinter'] = $qpDir .
'SMW_QP_List.php';
$wgAutoloadClasses['SMWCategoryResultPrinter'] = $qpDir .
'SMW_QP_Category.php';
Copied:
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Aggregatable.php
(from rev 103395,
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Distributable.php)
===================================================================
---
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Aggregatable.php
(rev 0)
+++
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Aggregatable.php
2011-11-16 22:27:01 UTC (rev 103398)
@@ -0,0 +1,225 @@
+<?php
+
+/**
+ * Result printer that supports the distribution parameter,
+ * and related parameters. It allows the user to choose between
+ * regular behaviour or getting a distribution of values.
+ *
+ * For example, this result set: foo bar baz foo bar bar ohi
+ * Will be turned into
+ * * bar (3)
+ * * foo (2)
+ * * baz (1)
+ * * ohi (1)
+ *
+ * @since 1.7
+ *
+ * @file SMW_QP_Aggregatable.php
+ * @ingroup SMWQuery
+ *
+ * @licence GNU GPL v3
+ * @author Jeroen De Dauw < [email protected] >
+ */
+abstract class SMWAggregatablePrinter extends SMWResultPrinter {
+
+ /**
+ * Create the formats output given the result data and return it.
+ *
+ * @since 1.7
+ *
+ * @param array $data label => value
+ */
+ protected abstract function getFormatOutput( array $data );
+
+ /**
+ * Method gets called right before the result is returned
+ * in case there are values to display. It is meant for
+ * adding resources such as JS and CSS only needed for this
+ * format when it has actual values.
+ *
+ * @since 1.7
+ */
+ protected function addResources() {}
+
+ /**
+ * (non-PHPdoc)
+ * @see SMWResultPrinter::getResultText()
+ */
+ protected function getResultText( SMWQueryResult $result, $outputmode )
{
+ $data = $this->getResults( $result, $outputmode );
+
+ if ( count( $data ) == 0 ) {
+ // This is wikitext, so no escaping needed.
+ return '<span class="error">' . wfMsgForContent(
'srf-warn-empy-chart' ) . '</span>';
+
+ // This makes the parser go mad :/
+// global $wgParser;
+// return $wgParser->parse(
+// '{{#info:' . wfMsgForContent(
'srf-warn-empy-chart' ) . '|warning}}',
+// Title::newMainPage(),
+// ( new ParserOptions() )
+// )->getText();
+ }
+ else {
+ $this->applyDistributionParams( $data );
+ $this->addResources();
+ return $this->getFormatOutput( $data );
+ }
+ }
+
+ /**
+ * Apply the distribution specific parameters.
+ *
+ * @since 1.7
+ *
+ * @param array $data
+ */
+ protected function applyDistributionParams( array &$data ) {
+ if ( $this->params['distributionsort'] == 'asc' ) {
+ asort( $data, SORT_NUMERIC );
+ }
+ else if ( $this->params['distributionsort'] == 'desc' ) {
+ arsort( $data, SORT_NUMERIC );
+ }
+
+ if ( $this->params['distributionlimit'] !== false ) {
+ $data = array_slice( $data, 0,
$this->params['distributionlimit'], true );
+ }
+ }
+
+ /**
+ * Gets and processes the results so they can be fed directly to the
+ * getFormatOutput method. They are returned as an array with the keys
+ * being the labels and the values being their corresponding (numeric)
values.
+ *
+ * @since 1.7
+ *
+ * @param SMWQueryResult $result
+ * @param $outputmode
+ *
+ * @return array label => value
+ */
+ protected function getResults( SMWQueryResult $result, $outputmode ) {
+ if ( $this->params['distribution'] ) {
+ return $this->getDistributionResults( $result,
$outputmode );
+ }
+ else {
+ return $this->getNumericResults( $result, $outputmode );
+ }
+ }
+
+ /**
+ * Counts all the occurances of all values in the query result,
+ * and returns an array with as key the value and as value the count.
+ *
+ * @since 1.7
+ *
+ * @param SMWQueryResult $res
+ * @param $outputmode
+ *
+ * @return array label => value
+ */
+ protected function getDistributionResults( SMWQueryResult $result,
$outputmode ) {
+ $values = array();
+
+ while ( /* array of SMWResultArray */ $row = $result->getNext()
) { // Objects (pages)
+ for ( $i = 0, $n = count( $row ); $i < $n; $i++ ) { //
SMWResultArray for a sinlge property
+ while ( ( /* SMWDataValue */ $dataValue =
$row[$i]->getNextDataValue() ) !== false ) { // Data values
+
+ // Get the HTML for the tag content.
Pages are linked, other stuff is just plaintext.
+ if ( $dataValue->getTypeID() == '_wpg'
) {
+ $value =
$dataValue->getTitle()->getText();
+ }
+ else {
+ $value =
$dataValue->getShortText( $outputmode, $this->getLinker( false ) );
+ }
+
+ if ( !array_key_exists( $value, $values
) ) {
+ $values[$value] = 0;
+ }
+
+ $values[$value]++;
+ }
+ }
+ }
+
+ return $values;
+ }
+
+ /**
+ * Returns an array with the numerical data in the query result.
+ *
+ * @since 1.7
+ *
+ * @param SMWQueryResult $res
+ * @param $outputmode
+ *
+ * @return array label => value
+ */
+ protected function getNumericResults( SMWQueryResult $res, $outputmode
) {
+ $values = array();
+
+ // print all result rows
+ while ( $row = $res->getNext() ) {
+ $dataValue = $row[0]->getNextDataValue();
+
+ if ( $dataValue !== false ) {
+ $name = $dataValue->getShortWikiText();
+
+ foreach ( $row as $field ) {
+ while ( ( /* SMWDataItem */ $dataItem =
$field->getNextDataItem() ) !== false ) {
+ $this->addNumbersForDataItem(
$dataItem, $values, $name );
+ }
+ }
+ }
+ }
+
+ return $values;
+ }
+
+ /**
+ * Adds all numbers contained in a dataitem to the list.
+ *
+ * @since 1.7
+ *
+ * @param SMWDataItem $dataItem
+ * @param array $values
+ * @param string $name
+ */
+ protected function addNumbersForDataItem( SMWDataItem $dataItem, array
&$values, $name ) {
+ switch ( $dataItem->getDIType() ) {
+ case SMWDataItem::TYPE_NUMBER:
+ $values[$name] = $dataItem->getNumber();
+ break;
+ case SMWDataItem::TYPE_CONTAINER:
+ foreach ( $dataItem->getDataItems() as $di ) {
+ $this->addNumbersForDataItem( $di,
$values, $name );
+ }
+ break;
+ default:
+ }
+ }
+
+ /**
+ * @see SMWResultPrinter::getParameters
+ * @since 1.7
+ */
+ public function getParameters() {
+ $params = parent::getParameters();
+
+ $params['distribution'] = new Parameter( 'distribution',
Parameter::TYPE_BOOLEAN, false );
+ $params['distribution']->setMessage(
'smw-paramdesc-distribution' );
+
+ $params['distributionsort'] = new Parameter(
'distributionsort', Parameter::TYPE_STRING, 'none' );
+ $params['distributionsort']->setMessage(
'smw-paramdesc-distributionsort' );
+ $params['distributionsort']->addCriteria( new CriterionInArray(
'asc', 'desc', 'none' ) );
+
+ $params['distributionlimit'] = new Parameter(
'distributionlimit', Parameter::TYPE_INTEGER );
+ $params['distributionlimit']->setDefault( false, false );
+ $params['distributionlimit']->setMessage(
'smw-paramdesc-distributionlimit' );
+ $params['distributionlimit']->addCriteria( new
CriterionInRange( 1, false ) );
+
+ return $params;
+ }
+
+}
Deleted:
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Distributable.php
===================================================================
---
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Distributable.php
2011-11-16 22:24:36 UTC (rev 103397)
+++
trunk/extensions/SemanticMediaWiki/includes/queryprinters/SMW_QP_Distributable.php
2011-11-16 22:27:01 UTC (rev 103398)
@@ -1,225 +0,0 @@
-<?php
-
-/**
- * Result printer that supports the distribution parameter,
- * and related parameters. It allows the user to choose between
- * regular behaviour or getting a distribution of values.
- *
- * For example, this result set: foo bar baz foo bar bar ohi
- * Will be turned into
- * * bar (3)
- * * foo (2)
- * * baz (1)
- * * ohi (1)
- *
- * @since 1.7
- *
- * @file SMW_QP_Distributable.php
- * @ingroup SMWQuery
- *
- * @licence GNU GPL v3
- * @author Jeroen De Dauw < [email protected] >
- */
-abstract class SMWDistributablePrinter extends SMWResultPrinter {
-
- /**
- * Create the formats output given the result data and return it.
- *
- * @since 1.7
- *
- * @param array $data label => value
- */
- protected abstract function getFormatOutput( array $data );
-
- /**
- * Method gets called right before the result is returned
- * in case there are values to display. It is meant for
- * adding resources such as JS and CSS only needed for this
- * format when it has actual values.
- *
- * @since 1.7
- */
- protected function addResources() {}
-
- /**
- * (non-PHPdoc)
- * @see SMWResultPrinter::getResultText()
- */
- protected function getResultText( SMWQueryResult $result, $outputmode )
{
- $data = $this->getResults( $result, $outputmode );
-
- if ( count( $data ) == 0 ) {
- // This is wikitext, so no escaping needed.
- return '<span class="error">' . wfMsgForContent(
'srf-warn-empy-chart' ) . '</span>';
-
- // This makes the parser go mad :/
-// global $wgParser;
-// return $wgParser->parse(
-// '{{#info:' . wfMsgForContent(
'srf-warn-empy-chart' ) . '|warning}}',
-// Title::newMainPage(),
-// ( new ParserOptions() )
-// )->getText();
- }
- else {
- $this->applyDistributionParams( $data );
- $this->addResources();
- return $this->getFormatOutput( $data );
- }
- }
-
- /**
- * Apply the distribution specific parameters.
- *
- * @since 1.7
- *
- * @param array $data
- */
- protected function applyDistributionParams( array &$data ) {
- if ( $this->params['distributionsort'] == 'asc' ) {
- asort( $data, SORT_NUMERIC );
- }
- else if ( $this->params['distributionsort'] == 'desc' ) {
- arsort( $data, SORT_NUMERIC );
- }
-
- if ( $this->params['distributionlimit'] !== false ) {
- $data = array_slice( $data, 0,
$this->params['distributionlimit'], true );
- }
- }
-
- /**
- * Gets and processes the results so they can be fed directly to the
- * getFormatOutput method. They are returned as an array with the keys
- * being the labels and the values being their corresponding (numeric)
values.
- *
- * @since 1.7
- *
- * @param SMWQueryResult $result
- * @param $outputmode
- *
- * @return array label => value
- */
- protected function getResults( SMWQueryResult $result, $outputmode ) {
- if ( $this->params['distribution'] ) {
- return $this->getDistributionResults( $result,
$outputmode );
- }
- else {
- return $this->getNumericResults( $result, $outputmode );
- }
- }
-
- /**
- * Counts all the occurances of all values in the query result,
- * and returns an array with as key the value and as value the count.
- *
- * @since 1.7
- *
- * @param SMWQueryResult $res
- * @param $outputmode
- *
- * @return array label => value
- */
- protected function getDistributionResults( SMWQueryResult $result,
$outputmode ) {
- $values = array();
-
- while ( /* array of SMWResultArray */ $row = $result->getNext()
) { // Objects (pages)
- for ( $i = 0, $n = count( $row ); $i < $n; $i++ ) { //
SMWResultArray for a sinlge property
- while ( ( /* SMWDataValue */ $dataValue =
$row[$i]->getNextDataValue() ) !== false ) { // Data values
-
- // Get the HTML for the tag content.
Pages are linked, other stuff is just plaintext.
- if ( $dataValue->getTypeID() == '_wpg'
) {
- $value =
$dataValue->getTitle()->getText();
- }
- else {
- $value =
$dataValue->getShortText( $outputmode, $this->getLinker( false ) );
- }
-
- if ( !array_key_exists( $value, $values
) ) {
- $values[$value] = 0;
- }
-
- $values[$value]++;
- }
- }
- }
-
- return $values;
- }
-
- /**
- * Returns an array with the numerical data in the query result.
- *
- * @since 1.7
- *
- * @param SMWQueryResult $res
- * @param $outputmode
- *
- * @return array label => value
- */
- protected function getNumericResults( SMWQueryResult $res, $outputmode
) {
- $values = array();
-
- // print all result rows
- while ( $row = $res->getNext() ) {
- $dataValue = $row[0]->getNextDataValue();
-
- if ( $dataValue !== false ) {
- $name = $dataValue->getShortWikiText();
-
- foreach ( $row as $field ) {
- while ( ( /* SMWDataItem */ $dataItem =
$field->getNextDataItem() ) !== false ) {
- $this->addNumbersForDataItem(
$dataItem, $values, $name );
- }
- }
- }
- }
-
- return $values;
- }
-
- /**
- * Adds all numbers contained in a dataitem to the list.
- *
- * @since 1.7
- *
- * @param SMWDataItem $dataItem
- * @param array $values
- * @param string $name
- */
- protected function addNumbersForDataItem( SMWDataItem $dataItem, array
&$values, $name ) {
- switch ( $dataItem->getDIType() ) {
- case SMWDataItem::TYPE_NUMBER:
- $values[$name] = $dataItem->getNumber();
- break;
- case SMWDataItem::TYPE_CONTAINER:
- foreach ( $dataItem->getDataItems() as $di ) {
- $this->addNumbersForDataItem( $di,
$values, $name );
- }
- break;
- default:
- }
- }
-
- /**
- * @see SMWResultPrinter::getParameters
- * @since 1.7
- */
- public function getParameters() {
- $params = parent::getParameters();
-
- $params['distribution'] = new Parameter( 'distribution',
Parameter::TYPE_BOOLEAN, false );
- $params['distribution']->setMessage(
'smw-paramdesc-distribution' );
-
- $params['distributionsort'] = new Parameter(
'distributionsort', Parameter::TYPE_STRING, 'none' );
- $params['distributionsort']->setMessage(
'smw-paramdesc-distributionsort' );
- $params['distributionsort']->addCriteria( new CriterionInArray(
'asc', 'desc', 'none' ) );
-
- $params['distributionlimit'] = new Parameter(
'distributionlimit', Parameter::TYPE_INTEGER );
- $params['distributionlimit']->setDefault( false, false );
- $params['distributionlimit']->setMessage(
'smw-paramdesc-distributionlimit' );
- $params['distributionlimit']->addCriteria( new
CriterionInRange( 1, false ) );
-
- return $params;
- }
-
-}
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
