SemanticMediaWiki/includes/params/SMW_ParamFormat.php

Go to the documentation of this file.

<?php

class SMWParamFormat extends ItemParameterManipulation {

        protected $printRequests = null;
        
        public function __construct() {
                parent::__construct();
        }
        
        public function doManipulation( &$value, Parameter $parameter, array &$parameters ) {
                // Make sure the format value is valid.
                $value = self::getValidFormatName( $value );
                
                // Add the formats parameters to the parameter list.
                $queryPrinter = SMWQueryProcessor::getResultPrinter( $value );
                
                $parameters = array_merge( $parameters, $queryPrinter->getValidatorParameters() );
        }
        
        protected function getValidFormatName( $value ) {
                global $smwgResultFormats;
                
                $value = strtolower( trim( $value ) );
                
                if ( !array_key_exists( $value, $smwgResultFormats ) ) {
                        $isAlias = self::resolveFormatAliases( $value );
                        
                        if ( !$isAlias ) {
                                $value = $this->getDefaultFormat();
                        }
                }
                
                return $value;
        }
        
        public static function resolveFormatAliases( &$format ) {
                global $smwgResultAliases;

                $isAlias = false;

                foreach ( $smwgResultAliases as $mainFormat => $aliases ) {
                        if ( in_array( $format, $aliases ) ) {
                                $format = $mainFormat;
                                $isAlias = true;
                                break;
                        }
                }

                return $isAlias;
        }
        
        protected function getDefaultFormat() {
                if ( is_null( $this->printRequests ) ) {
                        return 'table';
                }
                else {
                        $format = false;
                        
                        wfRunHooks( 'SMWResultFormat', array( &$format, $this->printRequests, array() ) );              

                        // If no default was set by an extension, use a table or list, depending on the column count.
                        if ( $format === false ) {
                                $format = count( $this->printRequests ) == 1 ? 'list' : 'table';
                        }
                        
                        return $format;
                }
        }
        
        public function setPrintRequests( array /* of SMWPrintRequest */ $printRequests ) {
                $this->printRequests = $printRequests;
        }
        
}

---