SemanticMediaWiki/includes/queryprinters/SMW_QP_CSV.php

Go to the documentation of this file.

<?php
class SMWCsvResultPrinter extends SMWResultPrinter {
        
        protected $m_sep;

        protected function handleParameters( array $params, $outputmode ) {
                parent::handleParameters( $params, $outputmode );
                
                $this->m_sep = str_replace( '_', ' ', $params['sep'] );
        }

        public function getMimeType( $res ) {
                return 'text/csv';
        }

        public function getFileName( $res ) {
                return 'result.csv';
        }

        public function getQueryMode( $context ) {
                return ( $context == SMWQueryProcessor::SPECIAL_PAGE ) ? SMWQuery::MODE_INSTANCES : SMWQuery::MODE_NONE;
        }

        public function getName() {
                return wfMsg( 'smw_printername_csv' );
        }

        protected function getResultText( SMWQueryResult $res, $outputmode ) {
                $result = '';
                
                if ( $outputmode == SMW_OUTPUT_FILE ) { // make CSV file
                        $csv = fopen( 'php://temp', 'r+' );
                        
                        if ( $this->mShowHeaders ) {
                                $header_items = array();
                                
                                foreach ( $res->getPrintRequests() as $pr ) {
                                        $header_items[] = $pr->getLabel();
                                }
                                
                                fputcsv( $csv, $header_items, $this->m_sep );
                        }
                        
                        while ( $row = $res->getNext() ) {
                                $row_items = array();
                                
                                foreach ( $row as /* SMWResultArray */ $field ) {
                                        $growing = array();
                                        
                                        while ( ( $object = $field->getNextDataValue() ) !== false ) {
                                                $growing[] = Sanitizer::decodeCharReferences( $object->getWikiValue() );
                                        } 
                                        
                                        $row_items[] = implode( ',', $growing );
                                }
                                
                                fputcsv( $csv, $row_items, $this->m_sep );
                        }

                        rewind( $csv );
                        $result .= stream_get_contents( $csv );
                } else { // just make link to feed
                        if ( $this->getSearchLabel( $outputmode ) ) {
                                $label = $this->getSearchLabel( $outputmode );
                        } else {
                                $label = wfMsgForContent( 'smw_csv_link' );
                        }

                        $link = $res->getQueryLink( $label );
                        $link->setParameter( 'csv', 'format' );
                        $link->setParameter( $this->m_sep, 'sep' );
                        
                        if ( array_key_exists( 'mainlabel', $this->params ) && $this->params['mainlabel'] !== false ) {
                                $link->setParameter( $this->params['mainlabel'], 'mainlabel' );
                        }
                                
                        $link->setParameter( $this->mShowHeaders ? 'show' : 'hide', 'headers' );
                        
                        if ( array_key_exists( 'limit', $this->params ) ) {
                                $link->setParameter( $this->params['limit'], 'limit' );
                        } else { // use a reasonable default limit
                                $link->setParameter( 100, 'limit' );
                        }
                        
                        $result .= $link->getText( $outputmode, $this->mLinker );
                        $this->isHTML = ( $outputmode == SMW_OUTPUT_HTML ); // yes, our code can be viewed as HTML if requested, no more parsing needed
                }
                return $result;
        }

        public function getParameters() {
                $params = array_merge( parent::getParameters(), $this->exportFormatParameters() );
                
                $params['sep'] = new Parameter( 'sep' );
                $params['sep']->setMessage( 'smw-paramdesc-csv-sep' );
                $params['sep']->setDefault( ',' );
                
                return $params;
        }

}

---