MakeGlobalVariablesScript hook. * * Sets the value of the wgRelatedArticles global variable * to the list of related articles in the cached parser output. * * @param array $vars * @param OutputPage $out * @return boolean Always true */ public static function onMakeGlobalVariablesScript( &$vars, OutputPage $out ) { $config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' ); $vars['wgRelatedArticles'] = $out->getProperty( 'RelatedArticles' ); $vars['wgRelatedArticlesUseCirrusSearch'] = $config->get( 'RelatedArticlesUseCirrusSearch' ); $vars['wgRelatedArticlesOnlyUseCirrusSearch'] = $config->get( 'RelatedArticlesOnlyUseCirrusSearch' ); return true; } /** * Handler for the BeforePageDisplay hook. * * Adds the ext.relatedArticles.readMore.bootstrap module * to the output when: * *
    *
  1. $wgRelatedArticlesShowInFooter is truthy
  2. *
  3. On mobile, the output is being rendered with * SkinMinervaBeta
  4. *
  5. On desktop, the beta feature has been enabled
  6. *
  7. The page is in mainspace
  8. *
* * @param OutputPage $out * @param Skin $skin * @return boolean Always true */ public static function onBeforePageDisplay( OutputPage $out, Skin $skin ) { $config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' ); $showReadMore = $config->get( 'RelatedArticlesShowInFooter' ); $title = $out->getContext()->getTitle(); if ( $showReadMore && $title->inNamespace( NS_MAIN ) && !$title->isMainPage() ) { if ( get_class( $skin ) === 'SkinMinervaBeta' || ( class_exists( 'BetaFeatures' ) && BetaFeatures::isFeatureEnabled( $out->getUser(), 'read-more' ) ) ) { $out->addModules( array( 'ext.relatedArticles.readMore.bootstrap' ) ); } } return true; } /** * EventLoggingRegisterSchemas hook handler. * * Registers our EventLogging schemas so that they can be converted to * ResourceLoaderSchemaModules by the EventLogging extension. * * If the module has already been registered in * onResourceLoaderRegisterModules, then it is overwritten. * * @param array $schemas The schemas currently registered with the EventLogging * extension * @return bool Always true */ public static function onEventLoggingRegisterSchemas( &$schemas ) { // @see https://meta.wikimedia.org/wiki/Schema:RelatedArticles $schemas['RelatedArticles'] = 14496900; return true; } /** * ResourceLoaderGetConfigVars hook handler for setting a config variable * @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars * * @param array $vars * @return boolean */ public static function onResourceLoaderGetConfigVars( &$vars ) { $config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' ); $vars['wgRelatedArticlesLoggingSamplingRate'] = $config->get( 'RelatedArticlesLoggingSamplingRate' ); return true; } /** * Register the "ext.relatedArticles.readMore" module. * Optionally update the dependencies and scripts if EventLogging is installed. * * @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderRegisterModules * * @param ResourceLoader &$resourceLoader The ResourceLoader object * @return boolean */ public static function onResourceLoaderRegisterModules( ResourceLoader &$resourceLoader ) { $dependencies = array( "mediawiki.user", "mediawiki.util" ); $scripts = array( "resources/ext.relatedArticles.readMore/index.js" ); if ( class_exists( 'EventLogging' ) ) { $dependencies[] = "mediawiki.viewport"; $dependencies[] = "ext.eventLogging.Schema"; $scripts[] = "resources/ext.relatedArticles.readMore/eventLogging.js"; } $resourceLoader->register( "ext.relatedArticles.readMore", array( "dependencies" => $dependencies, "scripts" => $scripts, "styles" => array( "resources/ext.relatedArticles.readMore/readMore.less" ), "skinStyles" => array( "default" => "resources/ext.relatedArticles.readMore/readMore.default.less", "monobook" => array( "resources/ext.relatedArticles.readMore/readMore.default.less", "resources/ext.relatedArticles.readMore/readMore.monobook.less" ), "minerva" => "resources/ext.relatedArticles.readMore/readMore.minerva.less" ), "messages" => array( "relatedarticles-read-more-heading" ), "targets" => array( "desktop", "mobile" ), "localBasePath" => __DIR__ . "/..", "remoteExtPath" => "RelatedArticles" ) ); return true; } /** * GetBetaFeaturePreferences hook handler * The beta feature is for showing ReadMore, not for showing related * articles in the sidebar. * @see https://www.mediawiki.org/wiki/Manual:Hooks/GetBetaFeaturePreferences * * @param User $user * @param array $preferences * * @return bool */ public static function onGetBetaFeaturePreferences( User $user, array &$preferences ) { $config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' ); $showReadMore = $config->get( 'RelatedArticlesShowInFooter' ); if ( $showReadMore ) { $wgExtensionAssetsPath = $config->get( 'ExtensionAssetsPath' ); $preferences['read-more'] = array( 'label-message' => 'relatedarticles-read-more-beta-feature-title', 'desc-message' => 'relatedarticles-read-more-beta-feature-description', 'screenshot' => array( 'ltr' => "$wgExtensionAssetsPath/RelatedArticles/images/BetaFeatures/wb-readmore-beta-ltr.svg", 'rtl' => "$wgExtensionAssetsPath/RelatedArticles/images/BetaFeatures/wb-readmore-beta-rtl.svg", ), 'info-link' => 'https://www.mediawiki.org/wiki/Reading/Web/Projects/Read_more', 'discussion-link' => 'https://www.mediawiki.org/wiki/Talk:Reading/Web/Projects/Read_more', ); } return true; } }