SemanticMediaWiki/includes/queryprinters/SMW_QP_Aggregatable.php

Go to the documentation of this file.

<?php

abstract class SMWAggregatablePrinter extends SMWResultPrinter {

        protected abstract function getFormatOutput( array $data );

        protected function addResources() {}

        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 );
                }
        }

        protected function applyDistributionParams( array &$data ) {
                if ( $this->params['distributionsort'] == 'asc' ) {
                        asort( $data, SORT_NUMERIC );
                }
                elseif ( $this->params['distributionsort'] == 'desc' ) {
                        arsort( $data, SORT_NUMERIC );
                }

                if ( $this->params['distributionlimit'] !== false ) {
                        $data = array_slice( $data, 0, $this->params['distributionlimit'], true );
                }
        }

        protected function getResults( SMWQueryResult $result, $outputmode ) {
                if ( $this->params['distribution'] ) {
                        return $this->getDistributionResults( $result, $outputmode );
                }
                else {
                        return $this->getNumericResults( $result, $outputmode );
                }
        }

        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;
        }

        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;
        }

        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:
                }
        }

        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;
        }

}

---