SemanticMediaWiki/includes/SMW_Outputs.php

Go to the documentation of this file.

<?php

class SMWOutputs {

        protected static $headItems = array();

        protected static $scripts = array();
        
        protected static $resourceModules = array();

        public static function requireResource( $moduleName ) {
                self::$resourceModules[$moduleName] = $moduleName;
        }

        public static function requireScript( $id, $script ) {
                self::$scripts[$id] = $script;
        }
        
        public static function requireHeadItem( $id, $item = '' ) {
                if ( is_numeric( $id ) ) {
                        switch ( $id ) {
                                case SMW_HEADER_TOOLTIP:
                                        self::requireResource( 'ext.smw.tooltips' );
                                break;
                                case SMW_HEADER_STYLE:
                                        self::requireResource( 'ext.smw.style' );
                                break;
                        }
                } else {
                        self::$headItems[$id] = $item;
                }
        }

        static public function requireFromParserOutput( ParserOutput $parserOutput ) {
                // Note: we do not attempt to recover which head items where scripts here.
                // ParserOutpt::getHeadItems() was added in MW 1.16
                if ( is_callable( array( $parserOutput, 'getHeadItems' ) ) ) {
                        $parserOutputHeadItems = $parserOutput->getHeadItems();
                } else {
                        $parserOutputHeadItems = (array)$parserOutput->headItems;
                }
                self::$headItems = array_merge( (array)self::$headItems, $parserOutputHeadItems );
                if ( isset( $parserOutput->mModules ) ) {
                        foreach ( $parserOutput->mModules as $module ) {
                                self::$resourceModules[$module] = $module;
                        }
                }
        }

        static public function commitToParser( Parser $parser ) {
                if ( method_exists( $parser, 'getOutput' ) ) {
                        $po = $parser->getOutput();
                } else {
                        $po = $parser->mOutput;
                }

                if ( isset( $po ) ) {
                        self::commitToParserOutput( $po );
                }
        }

        static public function commitToParserOutput( ParserOutput $parserOutput ) {
                foreach ( self::$scripts as $key => $script ) {
                        $parserOutput->addHeadItem( $script . "\n", $key );
                }
                foreach ( self::$headItems as $key => $item ) {
                        $parserOutput->addHeadItem( "\t\t" . $item . "\n", $key );
                }

                // Check if the resource loader can be used or not.
                if ( method_exists( $parserOutput, 'addModules' ) ) {
                        $parserOutput->addModules( array_values( self::$resourceModules ) );
                } else {
                        self::addModulesBC( $parserOutput );
                }

                self::$resourceModules = array();
                self::$headItems = array();
        }

        static public function commitToOutputPage( OutputPage $output ) {
                foreach ( self::$scripts as $script ) {
                        $output->addScript( $script );
                }
                foreach ( self::$headItems as $key => $item ) {
                        $output->addHeadItem( $key, "\t\t" . $item . "\n" );
                }

                // Check if the resource loader can be used or not.
                if ( method_exists( $output, 'addModules' ) ) {
                        $output->addModules( array_values( self::$resourceModules ) );
                } else {
                        self::addModulesBC( $output );
                }

                self::$resourceModules = array();
                self::$headItems = array();
        }

        static public function addModulesBC( $output ) {
                $items = array();
                foreach ( self::$resourceModules as $moduleName ) {
                        self::processModuleBC( $moduleName, $items );
                }
                foreach ( $items as $key => $item ) {
                        $output->addHeadItem( $key, $item );
                }
        }

        static public function processModuleBC( $moduleName, &$items  ) {
                global $wgResourceModules, $wgContLang, $smwgScriptPath;

                if ( array_key_exists( $moduleName, $wgResourceModules ) ) {
                        $module = $wgResourceModules[$moduleName];
                        $basePath = $module['remoteBasePath'];
                        foreach( self::getValueArrayForKey( 'dependencies', $module ) as $dependency ) {
                                self::processModuleBC( $dependency, $items );
                        }
                        if ( $moduleName == 'ext.smw.style' && $wgContLang->isRTL() ) { // manual RTL support
                                // This is obsolete with Resource Loader, since it flips styles automatically
                                $items["CSSRTL"] = "<link rel=\"stylesheet\" type=\"text/css\" href=\"$smwgScriptPath/skins/SMW_custom_rtl.css\" />\n";
                        }
                        foreach( self::getValueArrayForKey( 'scripts', $module ) as $script ) {
                                $items["JS$script"] = "<script type=\"text/javascript\" src=\"$basePath/$script\"></script>\n";
                        }
                        foreach( self::getValueArrayForKey( 'styles', $module ) as $style ) {
                                $items["CSS$style"] = "<link rel=\"stylesheet\" type=\"text/css\" href=\"$basePath/$style\" />\n";
                        }
                }
        }

        static public function getValueArrayForKey( $key, $array ) {
                if ( !array_key_exists( $key, $array ) ) {
                        return array();
                } elseif ( is_array( $array[$key] ) ) {
                        return $array[$key];
                } else {
                        return array( $array[$key] );
                }
        }

}

---