SemanticMaps/includes/queryprinters/SM_QueryHandler.php

Go to the documentation of this file.

<?php

class SMQueryHandler {

        protected $queryResult;
        protected $outputmode;

        protected $locations = false;

        protected $template = false;

        public $icon = '';

        public $text = '';

        public $title = '';

        public $titleLinkSeparate;

        protected $linkAbsolute;

        protected $pageLinkText;

        protected $subjectSeparator = '<hr />';

        protected $boldSubject = true;

        protected $showSubject = true;

        public function __construct( SMWQueryResult $queryResult, $outputmode, $linkAbsolute = false, $pageLinkText = '$1', $titleLinkSeparate = false ) {
                $this->queryResult = $queryResult;
                $this->outputmode = $outputmode;

                $this->linkAbsolute = $linkAbsolute;
                $this->pageLinkText = $pageLinkText;
                $this->titleLinkSeparate = $titleLinkSeparate;
        }

        public function setTemplate( $template ) {
                $this->template = $template === '' ? false : $template;
        }

        public function setIcon( $icon ) {
                $this->icon = $icon;
        }

        public function setTitle( $title ) {
                $this->title = $title;
        }

        public function setText( $text ) {
                $this->text = $text;
        }

        public function setSubjectSeparator( $subjectSeparator ) {
                $this->subjectSeparator = $subjectSeparator;
        }

        public function setBoldSubject( $boldSubject ) {
                $this->boldSubject = $boldSubject;
        }

        public function setShowSubject( $showSubject ) {
                $this->showSubject = $showSubject;
        }

        public function setPageLinkText( $text ) {
                $this->pageLinkText = $text;
        }

        public function getLocations() {
                if ( $this->locations === false ) {
                        $this->locations = $this->findLocations();
                }

                return $this->locations;
        }

        protected function findLocations() {
                $locations = array();

                while ( ( $row = $this->queryResult->getNext() ) !== false ) {
                        $locations = array_merge( $locations, $this->handleResultRow( $row ) );
                }

                return $locations;
        }

        protected function handleResultRow( array /* of SMWResultArray */ $row ) {
                $locations = array();
                $properties = array();

                $title = '';
                $text = '';

                // Loop throught all fields of the record.
                foreach ( $row as $i => $resultArray ) {
                        /* SMWPrintRequest */ $printRequest = $resultArray->getPrintRequest();

                        // Loop throught all the parts of the field value.
                        while ( ( /* SMWDataValue */ $dataValue = $resultArray->getNextDataValue() ) !== false ) {
                                if ( $dataValue->getTypeID() == '_wpg' && $i == 0 ) {
                                        list( $title, $text ) = $this->handleResultSubject( $dataValue );
                                }
                                else if ( $dataValue->getTypeID() == '_str' && $i == 0 ) {
                                        $title = $dataValue->getLongText( $this->outputmode, null );
                                        $text = $dataValue->getLongText( $this->outputmode, smwfGetLinker() );
                                }
                                else if ( $dataValue->getTypeID() != '_geo' && $i != 0 ) {
                                        $properties[] = $this->handleResultProperty( $dataValue, $printRequest );
                                }
                                else if ( $printRequest->getMode() == SMWPrintRequest::PRINT_PROP && $printRequest->getTypeID() == '_geo' ) {
                                        $dataItem = $dataValue->getDataItem();

                                        $location = MapsLocation::newFromLatLon( $dataItem->getLatitude(), $dataItem->getLongitude() );

                                        if ( $location->isValid() ) {
                                                $locations[] = $location;
                                        }

                                }
                        }
                }

                if ( count( $properties ) > 0 && $text !== '' ) {
                        $text .= $this->subjectSeparator;
                }

                $icon = $this->getLocationIcon( $row );

                return $this->buildLocationsList( $locations, $title, $text, $icon, $properties );
        }

        protected function handleResultSubject( SMWWikiPageValue $object ) {
                global $wgUser;

                $title = $object->getLongText( $this->outputmode, null );
                $text = '';

                if ( $this->showSubject ) {
                        if ( !$this->titleLinkSeparate && $this->linkAbsolute ) {
                                $text = Html::element(
                                        'a',
                                        array( 'href' => $object->getTitle()->getFullUrl() ),
                                        $object->getTitle()->getText()
                                );
                        }
                        else {
                                $text = $object->getLongText( $this->outputmode, smwfGetLinker() );
                        }

                        if ( $this->boldSubject ) {
                                $text = '<b>' . $text . '</b>';
                        }

                        if ( $this->titleLinkSeparate ) {
                                $txt = $object->getTitle()->getText();

                                if ( $this->pageLinkText !== '' ) {
                                        $txt = str_replace( '$1', $txt, $this->pageLinkText );
                                }
                                $text .= Html::element(
                                        'a',
                                        array( 'href' => $object->getTitle()->getFullUrl() ),
                                        $txt
                                );
                        }
                }

                return array( $title, $text );
        }

        protected function handleResultProperty( SMWDataValue $object, SMWPrintRequest $printRequest ) {
                global $wgUser;

                if ( $this->template ) {
                        if ( $object instanceof SMWWikiPageValue ) {
                                return $object->getTitle()->getPrefixedText();
                        } else {
                                return $object->getLongText( SMW_OUTPUT_WIKI, NULL );
                        }
                }

                if ( $this->linkAbsolute ) {
                        $t = Title::newFromText( $printRequest->getHTMLText( NULL ), SMW_NS_PROPERTY );

                        if ( $t instanceof Title && $t->exists() ) {
                                $propertyName = $propertyName = Html::element(
                                        'a',
                                        array( 'href' => $t->getFullUrl() ),
                                        $printRequest->getHTMLText( NULL )
                                );
                        }
                        else {
                                $propertyName = $printRequest->getHTMLText( NULL );
                        }
                }
                else {
                        $propertyName = $printRequest->getHTMLText( smwfGetLinker() );
                }

                if ( $this->linkAbsolute ) {
                        $hasPage = $object->getTypeID() == '_wpg';

                        if ( $hasPage ) {
                                $t = Title::newFromText( $object->getLongText( $this->outputmode, NULL ), NS_MAIN );
                                $hasPage = $t->exists();
                        }

                        if ( $hasPage ) {
                                $propertyValue = Html::element(
                                        'a',
                                        array( 'href' => $t->getFullUrl() ),
                                        $object->getLongText( $this->outputmode, NULL )
                                );
                        }
                        else {
                                $propertyValue = $object->getLongText( $this->outputmode, NULL );
                        }
                }
                else {
                        $propertyValue = $object->getLongText( $this->outputmode, smwfGetLinker() );
                }

                return $propertyName . ( $propertyName === '' ? '' : ': ' ) . $propertyValue;
        }

        protected function buildLocationsList( array $locations, $title, $text, $icon, array $properties ) {
                if ( $this->template ) {
                        global $wgParser;
                        $parser = version_compare( $GLOBALS['wgVersion'], '1.18', '<' ) ? $wgParser : clone $wgParser;
                }
                else {
                        $text .= implode( '<br />', $properties );
                }

                foreach ( $locations as $location ) {
                        if ( $this->template ) {
                                $segments = array_merge(
                                        array( $this->template, 'title=' . $title, 'latitude=' . $location->getLatitude(), 'longitude=' . $location->getLongitude() ),
                                        $properties
                                );

                                $text .= $parser->parse( '{{' . implode( '|', $segments ) . '}}', $parser->getTitle(), new ParserOptions() )->getText();
                        }

                        $location->setTitle( $title );
                        $location->setText( $text );
                        $location->setIcon( $icon );

                        $locations[] = $location;
                }

                return $locations;
        }

        protected function getLocationIcon( array $row ) {
                $icon = '';
                $legend_labels = array();

                // Look for display_options field, which can be set by Semantic Compound Queries
                // the location of this field changed in SMW 1.5
                $display_location = method_exists( $row[0], 'getResultSubject' ) ? $row[0]->getResultSubject() : $row[0];

                if ( property_exists( $display_location, 'display_options' ) && is_array( $display_location->display_options ) ) {
                        $display_options = $display_location->display_options;
                        if ( array_key_exists( 'icon', $display_options ) ) {
                                $icon = $display_options['icon'];

                                // This is somewhat of a hack - if a legend label has been set, we're getting it for every point, instead of just once per icon
                                if ( array_key_exists( 'legend label', $display_options ) ) {

                                        $legend_label = $display_options['legend label'];

                                        if ( ! array_key_exists( $icon, $legend_labels ) ) {
                                                $legend_labels[$icon] = $legend_label;
                                        }
                                }
                        }
                } // Icon can be set even for regular, non-compound queries If it is, though, we have to translate the name into a URL here
                elseif ( $this->icon !== '' ) {
                        $icon = MapsMapper::getFileUrl( $this->icon );
                }

                return $icon;
        }

}

---