SemanticResultFormats/Gallery/SRF_Gallery.php

Go to the documentation of this file.

<?php

class SRFGallery extends SMWResultPrinter {

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

        public function getResult( SMWQueryResult $results, array $params, $outputmode ) {
                // skip checks, results with 0 entries are normal
                $this->handleParameters( $params, $outputmode );
                return $this->getResultText( $results, SMW_OUTPUT_HTML );
        }

        public function getResultText( SMWQueryResult $results, $outputmode ) {
                global $wgUser, $wgParser;

                $ig = new ImageGallery();
                $ig->setShowBytes( false );
                $ig->setShowFilename( false );
                $ig->setParser( $wgParser );
                $ig->setCaption( $this->mIntro ); // set caption to IQ header

                if ( $this->params['galleryformat'] == 'carousel' ) {
                        static $carouselNr = 0;
                        
                        // Set attributes for jcarousel
                        $dataAttribs = array(
                                'wrap' => 'both', // Whether to wrap at the first/last item (or both) and jump back to the start/end.
                                'vertical' => 'false', // Orientation: vertical = false means horizontal
                                'rtl' => 'false', // Directionality: rtl = false means ltr
                        );

                        // Use perrow parameter to determine the scroll sequence.
                        if ( empty( $this->params['perrow'] ) ) {
                                $dataAttribs['scroll'] = 1;  // default 1
                        } else {
                                $dataAttribs['scroll'] = $this->params['perrow'];
                                $dataAttribs['visible'] = $this->params['perrow'];
                        }
                        
                        $attribs = array(
                                'id' => 'carousel' . ++$carouselNr,
                                'class' => 'jcarousel jcarousel-skin-smw',
                                'style' => 'display:none;', // Avoid js loading issues by not displaying anything until js is able to do so.
                        );
                        
                        foreach ( $dataAttribs as $name => $value ) {
                                $attribs['data-' . $name] = $value;
                        }

                        $ig->setAttributes( $attribs );

                        // Load javascript module
                        SMWOutputs::requireResource( 'ext.srf.jcarousel' );
                }

                // In case galleryformat = carousel, perrow should not be set
                if ( $this->params['perrow'] !== '' && $this->params['galleryformat'] !== 'carousel' ) {
                        $ig->setPerRow( $this->params['perrow'] );
                }

                if ( $this->params['widths'] !== '' ) {
                        $ig->setWidths( $this->params['widths'] );
                }

                if ( $this->params['heights'] !== '' ) {
                        $ig->setHeights( $this->params['heights'] );
                }

                $printReqLabels = array();

                foreach ( $results->getPrintRequests() as /* SMWPrintRequest */ $printReq ) {
                        $printReqLabels[] = $printReq->getLabel();
                }

                if ( $this->params['imageproperty'] !== '' && in_array( $this->params['imageproperty'], $printReqLabels ) ) {
                        $this->addImageProperties( $results, $ig, $this->params['imageproperty'], $this->params['captionproperty'] );
                }
                else {
                        $this->addImagePages( $results, $ig );
                }

                return array( $ig->toHTML(), 'nowiki' => true, 'isHTML' => true );
        }

        protected function addImageProperties( SMWQueryResult $results, ImageGallery &$ig, $imageProperty, $captionProperty ) {
                while ( /* array of SMWResultArray */ $row = $results->getNext() ) { // Objects (pages)
                        $images = array();
                        $captions = array();

                        for ( $i = 0, $n = count( $row ); $i < $n; $i++ ) { // Properties
                                if ( $row[$i]->getPrintRequest()->getLabel() == $imageProperty ) {
                                        while ( ( $obj = $row[$i]->getNextDataValue() ) !== false ) { // Property values
                                                if ( $obj->getTypeID() == '_wpg' ) {
                                                        $images[] = $obj->getTitle();
                                                }
                                        }
                                }
                                elseif ( $row[$i]->getPrintRequest()->getLabel() == $captionProperty ) {
                                        while ( ( $obj = $row[$i]->getNextDataValue() ) !== false ) { // Property values
                                                $captions[] = $obj->getShortText( SMW_OUTPUT_HTML, $this->getLinker( true ) );
                                        }
                                }
                        }

                        $amountMatches = count( $captions ) == count( $images );
                        $hasCaption = $amountMatches || count( $captions ) > 0;

                        foreach ( $images as $imgTitle ) {
                                if ( $imgTitle->exists() ) {
                                        $imgCaption = $hasCaption ? ( $amountMatches ? array_shift( $captions ) : $captions[0] ) : '';
                                        $this->addImageToGallery( $ig, $imgTitle, $imgCaption );
                                }
                        }
                }
        }

        protected function addImagePages( SMWQueryResult $results, ImageGallery &$ig ) {
                while ( $row = $results->getNext() ) {
                        $firstField = $row[0];
                        $nextObject = $firstField->getNextDataValue();

                        if ( $nextObject !== false ) {
                                $imgTitle = $nextObject->getTitle();
                                $imgCaption = '';

                                // Is there a property queried for display with ?property
                                if ( isset( $row[1] ) ) {
                                        $imgCaption = $row[1]->getNextDataValue();
                                        if ( is_object( $imgCaption ) ) {
                                                $imgCaption = $imgCaption->getShortText( SMW_OUTPUT_HTML, $this->getLinker( true ) );
                                        }
                                }

                                $this->addImageToGallery( $ig, $imgTitle, $imgCaption );
                        }
                }
        }

        protected function addImageToGallery( ImageGallery &$ig, Title $imgTitle, $imgCaption ) {
                global $wgParser;

                if ( empty( $imgCaption ) ) {
                        if ( $this->m_params['autocaptions'] ) {
                                $imgCaption = $imgTitle->getBaseText();

                                if ( !$this->m_params['fileextensions'] ) {
                                        $imgCaption = preg_replace( '#\.[^.]+$#', '', $imgCaption );
                                }
                        }
                        else {
                                $imgCaption = '';
                        }
                }
                else {
                        $imgCaption = $wgParser->recursiveTagParse( $imgCaption );
                        // the above call creates getMaxIncludeSize() fatal error on Special Pages
                        // below might fix this
                        // $imgCaption = $wgParser->transformMsg( $imgCaption, ParserOptions::newFromUser( null ) );
                }

                $ig->add( $imgTitle, $imgCaption );

                // Only add real images (bug #5586)
                if ( $imgTitle->getNamespace() == NS_IMAGE && !is_null( $imgTitle->getDBkey() ) ) {
                        $wgParser->mOutput->addImage( $imgTitle->getDBkey() );
                }
        }

        public function getParameters() {
                $params = parent::getParameters();

                if ( defined( 'MW_SUPPORTS_RESOURCE_MODULES' ) ) {
                        // Since 1.7.1
                        $params['galleryformat'] = new Parameter( 'galleryformat', Parameter::TYPE_STRING, '' );
                        $params['galleryformat']->setMessage( 'srf_paramdesc_galleryformat' );
                        $params['galleryformat']->addCriteria( new CriterionInArray( 'carousel' ) );
                }

                $params['perrow'] = new Parameter( 'perrow', Parameter::TYPE_INTEGER );
                $params['perrow']->setMessage( 'srf_paramdesc_perrow' );
                $params['perrow']->setDefault( '', false );

                $params['widths'] = new Parameter( 'widths', Parameter::TYPE_INTEGER );
                $params['widths']->setMessage( 'srf_paramdesc_widths' );
                $params['widths']->setDefault( '', false );

                $params['heights'] = new Parameter( 'heights', Parameter::TYPE_INTEGER );
                $params['heights']->setMessage( 'srf_paramdesc_heights' );
                $params['heights']->setDefault( '', false );

                $params['autocaptions'] = new Parameter( 'autocaptions', Parameter::TYPE_BOOLEAN );
                $params['autocaptions']->setMessage( 'srf_paramdesc_autocaptions' );
                $params['autocaptions']->setDefault( true );

                $params['fileextensions'] = new Parameter( 'fileextensions', Parameter::TYPE_BOOLEAN );
                $params['fileextensions']->setMessage( 'srf_paramdesc_fileextensions' );
                $params['fileextensions']->setDefault( false );

                $params['captionproperty'] = new Parameter( 'captionproperty' );
                $params['captionproperty']->setMessage( 'srf_paramdesc_captionproperty' );
                $params['captionproperty']->setDefault( '' );

                $params['imageproperty'] = new Parameter( 'imageproperty' );
                $params['imageproperty']->setMessage( 'srf_paramdesc_imageproperty' );
                $params['imageproperty']->setDefault( '' );

                return $params;
        }

}

---