tag to MW pages and into the parser output * * @file * @ingroup Extensions * @author Daniel Friesen (http://danf.ca/mw/) * @copyright Copyright 2010 – Daniel Friesen * @license https://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later * @link https://www.mediawiki.org/wiki/Extension:Description2 Documentation */ class Description2 { /** * @param Parser $parser The parser. * @param string $desc The description text. */ public static function setDescription( Parser $parser, $desc ) { $parserOutput = $parser->getOutput(); if ( $parserOutput->getProperty( 'description' ) !== false ) { return; } $parserOutput->setProperty( 'description', $desc ); } /** * @link https://www.mediawiki.org/wiki/Manual:Hooks/ParserAfterTidy * @param Parser &$parser The parser. * @param string &$text The page text. * @return bool */ public static function onParserAfterTidy( Parser &$parser, &$text ) { $desc = ''; $pattern = '%
.*?
#is', $myText, $paragraphs ) ) { foreach ( $paragraphs[0] as $paragraph ) { $paragraph = trim( strip_tags( $paragraph ) ); if ( !$paragraph ) { continue; } $desc = $paragraph; break; } } if ( $desc ) { self::setDescription( $parser, $desc ); } return true; } /** * @param Parser &$parser The parser. * @return bool */ public static function onParserFirstCallInit( Parser &$parser ) { $config = MediaWikiServices::getInstance() ->getConfigFactory() ->makeConfig( 'Description2' ); if ( !$config->get( 'EnableMetaDescriptionFunctions' ) ) { // Functions and tags are disabled return true; } $parser->setFunctionHook( 'description2', [ static::class, 'parserFunctionCallback' ], Parser::SFH_OBJECT_ARGS ); $parser->setFunctionTagHook( 'metadesc', [ static::class, 'tagCallback' ], Parser::SFH_OBJECT_ARGS ); return true; } /** * @param Parser $parser The parser. * @param PPFrame $frame The frame. * @param string[] $args The arguments of the parser function call. * @return string */ public static function parserFunctionCallback( Parser $parser, PPFrame $frame, $args ) { $desc = isset( $args[0] ) ? $frame->expand( $args[0] ) : ''; self::setDescription( $parser, $desc ); return ''; } /** * @param Parser $parser The parser. * @param PPFrame $frame Not used. * @param string $content The contents of the tag (if any). * @param string[] $attributes The tag attributes (if any). * @return string */ public static function tagCallback( Parser $parser, PPFrame $frame, $content, $attributes ) { $contentAttr = isset( $attributes['content'] ) ? $attributes['content'] : null; $desc = isset( $content ) ? $content : $contentAttr; if ( isset( $desc ) ) { self::setDescription( $parser, $desc ); } return ''; } /** * @param OutputPage &$out The output page to add the meta element to. * @param ParserOutput $parserOutput The parser output to get the description from. */ public static function onOutputPageParserOutput( OutputPage &$out, ParserOutput $parserOutput ) { // Export the description from the main parser output into the OutputPage $description = $parserOutput->getProperty( 'description' ); if ( $description !== false ) { $out->addMeta( 'description', $description ); } } }