mediawiki-extensions-Multim.../MultimediaViewerHooks.php

139 lines
4 KiB
PHP
Raw Normal View History

<?php
/*
* This file is part of the MediaWiki extension MultimediaViewer.
*
* MultimediaViewer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* MultimediaViewer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MultimediaViewer. If not, see <http://www.gnu.org/licenses/>.
*
* @file
* @ingroup extensions
* @author Mark Holmquist <mtraceur@member.fsf.org>
* @copyright Copyright © 2013, Mark Holmquist
*/
class MultimediaViewerHooks {
/** Link to more information about this module */
protected static $infoLink = '//mediawiki.org/wiki/Special:MyLanguage/Multimedia/About_Media_Viewer';
/** Link to a page where this module can be discussed */
protected static $discussionLink = '//mediawiki.org/wiki/Special:MyLanguage/Talk:Multimedia/About_Media_Viewer';
/**
* Handler for all places where we add the modules
* Could be on article pages or on Category pages
* @param OutputPage $out
* @return bool
*/
protected static function getModules( &$out ) {
if ( class_exists( 'BetaFeatures')
&& !BetaFeatures::isFeatureEnabled( $out->getUser(), 'multimedia-viewer' ) ) {
return true;
}
$out->addModules( array( 'mmv' ) );
return true;
}
/**
* Handler for BeforePageDisplay hook
* Add JavaScript to the page when an image is on it
* and the user has enabled the feature if BetaFeatures is installed
* @param OutputPage $out
* @param Skin $skin
* @return bool
*/
public static function getModulesForArticle( &$out, &$skin ) {
if ( count( $out->getFileSearchOptions() ) > 0 ) {
return self::getModules( $out );
}
return true;
}
/**
* Handler for CategoryPageView hook
* Add JavaScript to the page if there are images in the category
* @param CategoryPage $catPage
* @return bool
*/
public static function getModulesForCategory( &$catPage ) {
$title = $catPage->getTitle();
$cat = Category::newFromTitle( $title );
if ( $cat->getFileCount() > 0 ) {
$out = $catPage->getContext()->getOutput();
return self::getModules( $out );
}
return true;
}
// Add a beta preference to gate the feature
public static function getBetaPreferences( $user, &$prefs ) {
global $wgExtensionAssetsPath;
$dir = RequestContext::getMain()->getLanguage()->getDir();
$prefs['multimedia-viewer'] = array(
'label-message' => 'multimediaviewer-pref',
'desc-message' => 'multimediaviewer-pref-desc',
'info-link' => self::$infoLink,
'discussion-link' => self::$discussionLink,
'screenshot' => "$wgExtensionAssetsPath/MultimediaViewer/viewer-$dir.svg",
);
return true;
}
/**
* Export variables used in both PHP and JS to keep DRY
* @param array $vars
* @return bool
*/
public static function resourceLoaderGetConfigVars( &$vars ) {
$vars['wgMultimediaViewer'] = array(
'infoLink' => self::$infoLink,
'discussionLink' => self::$discussionLink,
);
return true;
}
/**
* Get modules for testing our JavaScript
* @param array $testModules
* @param ResourceLoader resourceLoader
* @return bool
*/
public static function getTestModules( array &$testModules, ResourceLoader &$resourceLoader ) {
$testModules['qunit']['mmv.tests'] = array(
'scripts' => array(
'tests/qunit/mmv.test.js',
'tests/qunit/mmv.model.test.js',
'tests/qunit/mmv.provider.test.js',
'tests/qunit/mmv.lightboxinterface.test.js',
'tests/qunit/mmv.ui.description.test.js',
'tests/qunit/lightboximage.test.js',
'tests/qunit/lightboxinterface.test.js',
'tests/qunit/multilightbox.test.js',
),
'dependencies' => array(
'mmv',
),
'localBasePath' => __DIR__,
'remoteExtPath' => 'MultimediaViewer',
);
return true;
}
}