diff options
Diffstat (limited to 'SemanticResultFormats/formats/timeseries/SRF_Timeseries.php')
| -rw-r--r-- | SemanticResultFormats/formats/timeseries/SRF_Timeseries.php | 266 |
1 files changed, 0 insertions, 266 deletions
diff --git a/SemanticResultFormats/formats/timeseries/SRF_Timeseries.php b/SemanticResultFormats/formats/timeseries/SRF_Timeseries.php deleted file mode 100644 index c1e48e4c..00000000 --- a/SemanticResultFormats/formats/timeseries/SRF_Timeseries.php +++ /dev/null @@ -1,266 +0,0 @@ -<?php - -/** - * A query printer for timeseries using the flot plotting JavaScript library - * - * @see http://www.semantic-mediawiki.org/wiki/Help:Flot_timeseries_chart - * @licence GNU GPL v2 or later - * - * @since 1.8 - * - * @author mwjames - */ -class SRFTimeseries extends SMWResultPrinter { - - /** - * @see SMWResultPrinter::getName - * @return string - */ - public function getName() { - return wfMessage( 'srf-printername-timeseries' )->text(); - } - - /** - * @see SMWResultPrinter::getResultText - * - * @param SMWQueryResult $result - * @param $outputMode - * - * @return string - */ - protected function getResultText( SMWQueryResult $result, $outputMode ) { - - // Data processing - $data = $this->getAggregatedTimeSeries( $result, $outputMode ); - - // Post-data processing check - if ( $data === array() ) { - return $result->addErrors( array( wfMessage( 'srf-warn-empy-chart' )->inContentLanguage()->text() ) ); - } else { - $options['sask'] = SRFUtils::htmlQueryResultLink( $this->getLink( $result, SMW_OUTPUT_HTML ) ); - return $this->getFormatOutput( $data, $options ); - } - } - - /** - * Returns an array with numerical data - * - * @since 1.8 - * - * @param SMWQueryResult $result - * @param $outputMode - * - * @return array - */ - protected function getAggregatedTimeSeries( SMWQueryResult $result, $outputMode ) { - $values = array(); - $aggregatedValues = array (); - - while ( /* array of SMWResultArray */ $row = $result->getNext() ) { // Objects (pages) - $timeStamp = ''; - $value = ''; - $series = array(); - - foreach ( $row as /* SMWResultArray */ $field ) { - $value = array(); - $sum = array(); - $rowSum = array(); - - // Group by subject (page object) or property - if ( $this->params['group'] == 'subject' ){ - $group = $field->getResultSubject()->getTitle()->getText(); - } else { - $group = $field->getPrintRequest()->getLabel(); - } - - while ( ( /* SMWDataValue */ $dataValue = $field->getNextDataValue() ) !== false ) { // Data values - - // Find the timestamp - if ( $dataValue->getDataItem()->getDIType() == SMWDataItem::TYPE_TIME ){ - // We work with a timestamp, we have to use intval because DataItem - // returns a string but we want a numeric representation of the timestamp - $timeStamp = intval( $dataValue->getDataItem()->getMwTimestamp() ); - } - - // Find the values (numbers only) - if ( $dataValue->getDataItem()->getDIType() == SMWDataItem::TYPE_NUMBER ){ - $sum[] = $dataValue->getNumber(); - } - } - // Aggegate individual values into a sum - $rowSum = array_sum( $sum ); - - // Check the sum and threshold/min - if ( $timeStamp !== '' && $rowSum == true && $rowSum >= $this->params['min'] ) { - $series[$group] = array ( $timeStamp , $rowSum ) ; - } - } - $values[] = $series ; - } - - // Re-assign values according to their group - foreach ( $values as $key => $value ) { - foreach ( $values[$key] as $row => $rowvalue ) { - $aggregatedValues[$row][] = $rowvalue; - } - } - return $aggregatedValues; - } - - /** - * Prepare data for the output - * - * @since 1.8 - * - * @param array $data - * - * @return string - */ - protected function getFormatOutput( array $data, $options ) { - - // Object count - static $statNr = 0; - $chartID = 'timeseries-' . ++$statNr; - - $this->isHTML = true; - - // Reorganize the raw data - foreach ( $data as $key => $values ) { - $dataObject[] = array ( 'label' => $key, 'data' => $values ); - } - - // Series colour - $seriescolors = $this->params['chartcolor'] !== '' ? array_filter( explode( "," , $this->params['chartcolor'] ) ) : array(); - - // Prepare transfer array - $chartData = array ( - 'data' => $dataObject, - 'fcolumntypeid' => '_dat', - 'sask' => $options['sask'], - 'parameters' => array ( - 'width' => $this->params['width'], - 'height' => $this->params['height'], - 'charttitle' => $this->params['charttitle'], - 'charttext' => $this->params['charttext'], - 'infotext' => $this->params['infotext'], - 'charttype' => $this->params['charttype'], - 'gridview' => $this->params['gridview'], - 'zoom' => $this->params['zoompane'], - 'seriescolors' => $seriescolors - ) - ); - - // Array encoding and output - $requireHeadItem = array ( $chartID => FormatJson::encode( $chartData ) ); - SMWOutputs::requireHeadItem( $chartID, Skin::makeVariablesScript( $requireHeadItem ) ); - - // RL module - SMWOutputs::requireResource( 'ext.srf.timeseries.flot' ); - - if ( $this->params['gridview'] === 'tabs' ) { - SMWOutputs::requireResource( 'ext.srf.util.grid' ); - } - - // Chart/graph placeholder - $chart = Html::rawElement( 'div', array( - 'id' => $chartID, - 'class' => 'container', - 'style' => "display:none;" - ), null - ); - - // Processing/loading image - $processing = SRFUtils::htmlProcessingElement( $this->isHTML ); - - // Beautify class selector - $class = $this->params['class'] ? ' ' . $this->params['class'] : ' flot-chart-common'; - - // General output marker - return Html::rawElement( 'div', array( - 'class' => 'srf-timeseries' . $class - ), $processing . $chart - ); - } - - /** - * @see SMWResultPrinter::getParamDefinitions - * - * @since 1.8 - * - * @param $definitions array of IParamDefinition - * - * @return array of IParamDefinition|array - */ - public function getParamDefinitions( array $definitions ) { - $params = parent::getParamDefinitions( $definitions ); - - $params['charttype'] = array( - 'message' => 'srf-paramdesc-layout', - 'default' => 'line', - 'values' => array( 'line', 'bar'), - ); - - $params['min'] = array( - 'type' => 'integer', - 'message' => 'srf-paramdesc-minvalue', - 'default' => '', - ); - - $params['gridview'] = array( - 'message' => 'srf-paramdesc-gridview', - 'default' => 'none', - 'values' => array( 'none' , 'tabs' ), - ); - - $params['group'] = array( - 'message' => 'srf-paramdesc-group', - 'default' => 'subject', - 'values' => array( 'property' , 'subject' ), - ); - - $params['zoompane'] = array( - 'message' => 'srf-paramdesc-zoompane', - 'default' => 'bottom', - 'values' => array( 'none' , 'bottom', 'top' ), - ); - - $params['height'] = array( - 'type' => 'integer', - 'message' => 'srf_paramdesc_chartheight', - 'default' => 400, - 'lowerbound' => 1, - ); - - $params['width'] = array( - 'message' => 'srf_paramdesc_chartwidth', - 'default' => '100%', - ); - - $params['charttitle'] = array( - 'message' => 'srf_paramdesc_charttitle', - 'default' => '', - ); - - $params['charttext'] = array( - 'message' => 'srf-paramdesc-charttext', - 'default' => '', - ); - - $params['infotext'] = array( - 'message' => 'srf-paramdesc-infotext', - 'default' => '', - ); - - $params['chartcolor'] = array( - 'message' => 'srf-paramdesc-chartcolor', - 'default' => '', - ); - - $params['class'] = array( - 'message' => 'srf-paramdesc-class', - 'default' => '', - ); - - return $params; - } -}
\ No newline at end of file |