mediawiki-extensions-Tabber.../includes/Tabber.php
alistair3149 8fdead811e
feat: add tracking categories for pages using Tabber
Pages with tabber/tabbertransclude tag will have a tracking category called Category:Pages using Tabber/TabberTransclude parser tag. To hide the category, put the __HIDDENCAT__ magic word on the category page
2022-05-06 13:09:03 -04:00

90 lines
2.2 KiB
PHP

<?php
/**
* TabberNeue
* Tabber Class
* Implement <tabber> tag
*
* @package TabberNeue
* @author alistair3149, Eric Fortin, Alexia E. Smith, Ciencia Al Poder
* @license GPL-3.0-or-later
* @link https://www.mediawiki.org/wiki/Extension:TabberNeue
*/
declare( strict_types=1 );
namespace TabberNeue;
use Parser;
use PPFrame;
class Tabber {
/**
* Parser callback for <tabber> tag
*
* @param string $input
* @param array $args
* @param Parser $parser Mediawiki Parser Object
* @param PPFrame $frame Mediawiki PPFrame Object
*
* @return string HTML
*/
public static function parserHook( string $input, array $args, Parser $parser, PPFrame $frame ) {
$tabber = new Tabber();
$html = $tabber->render( $input, $parser, $frame );
if ( $input === null ) {
return;
}
$parser->getOutput()->addModules( [ 'ext.tabberNeue' ] );
$parser->addTrackingCategory( 'tabberneue-tabber-category' );
return $html;
}
/**
* Renders the necessary HTML for a <tabber> tag.
*
* @param string $input The input URL between the beginning and ending tags.
* @param Parser $parser Mediawiki Parser Object
* @param PPFrame $frame Mediawiki PPFrame Object
*
* @return string HTML
*/
public static function render( $input, Parser $parser, PPFrame $frame ) {
$arr = explode( "|-|", $input );
$htmlTabs = '';
foreach ( $arr as $tab ) {
$htmlTabs .= self::buildTab( $tab, $parser, $frame );
}
$html = '<div class="tabber">' .
'<section class="tabber__section">' . $htmlTabs . "</section></div>";
return $html;
}
/**
* Build individual tab.
*
* @param string $tab Tab information
* @param Parser $parser Mediawiki Parser Object
* @param PPFrame $frame Mediawiki PPFrame Object
*
* @return string HTML
*/
private static function buildTab( $tab, Parser $parser, PPFrame $frame ) {
$tab = trim( $tab );
if ( empty( $tab ) ) {
return $tab;
}
// Use array_pad to make sure at least 2 array values are always returned
list( $tabName, $tabBody ) = array_pad( array_map( 'trim', explode( '=', $tab, 2 ) ), 2, '' );
$tabBody = $parser->recursiveTagParseFully( $tabBody, $frame );
$tab = '<article class="tabber__panel" title="' . htmlspecialchars( $tabName ) .
'">' . $tabBody . '</article>';
return $tab;
}
}