SidebarBeforeOutput hook.
*
* Retrieves the list of related pages
* and adds its HTML representation to the sidebar if the ReadMore feature
* is disabled and the beta feature is enabled by the user.
*
* @param Skin $skin
* @param array $bar
* @return boolean Always true
*/
public static function onSidebarBeforeOutput( Skin $skin, &$bar ) {
$out = $skin->getOutput();
$relatedPages = $out->getProperty( 'RelatedArticles' );
if ( !self::isInSidebar( $relatedPages, $out->getUser() ) ) {
return true;
}
$relatedPagesUrls = self::getRelatedPagesUrls( $relatedPages );
// build relatedarticles 's
$relatedPages = [];
foreach ( (array) $relatedPagesUrls as $url ) {
$relatedPages[] =
Html::rawElement( 'li', [ 'class' => htmlspecialchars( $url['class'] ) ],
Html::element( 'a', [ 'href' => htmlspecialchars( $url['href'] ) ],
$url['text']
)
);
}
// build complete html
$bar[$skin->msg( 'relatedarticles-title' )->text()] =
Html::rawElement( 'ul', [],
implode( '', $relatedPages )
);
return true;
}
/**
* Generates anchor element attributes for each entry in list of pages.
*
* The attributes that are generated are: href,
* text, and class, with the latter always
* set to "interwiki-relart".
*
* If the the page is of the form "Foo && Bar", then
* the text attribute will be set to "Bar", otherwise the
* page's {@see Title::getPrefixedText prefixed text} will be used.
*
* @param array[string] $relatedPages
* @return array An array of maps, each with href,
* text, and class entries.
*/
private static function getRelatedPagesUrls( array $relatedPages ) {
$relatedPagesUrls = [];
foreach ( $relatedPages as $page ) {
// Tribute to Evan
$page = urldecode( $page );
$altText = '';
if ( preg_match( '/\&\&/', $page ) ) {
$parts = array_map( 'trim', explode( '&&', $page, 2 ) );
$page = $parts[0];
$altText = $parts[1];
}
$title = Title::newFromText( $page );
if ( $title ) {
$relatedPagesUrls[] = [
'href' => $title->getLocalURL(),
'text' => $altText ?: $title->getPrefixedText(),
'class' => 'interwiki-relart'
];
}
};
return $relatedPagesUrls;
}
/**
* Check whether there are related articles that can be displayed, or
* the ReadMore feature is disabled. The beta feature is used only
* for enabling ReadMore, so do not take it into account.
*
* @param mixed $relatedPages
* @param User $user
* @return bool
* @throws \ConfigException
*/
private static function isInSidebar( $relatedPages, User $user ) {
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' );
if ( !$relatedPages || !$config->get( 'RelatedArticlesShowInSidebar' ) ) {
return false;
}
return true;
}
}