Wrap the output in a div with the provided class name. More...

Inherits MediaWiki\OutputTransform\ContentTextTransformStage.

Collaboration diagram for MediaWiki\OutputTransform\Stages\AddWrapperDivClass:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, LoggerInterface $logger, private LanguageFactory $langFactory, private Language $contentLang)

	shouldRun (ParserOutput $po, ParserOptions $popts, array $options=[])
	Decides whether or not the stage should be run.

Public Member Functions inherited from MediaWiki\OutputTransform\ContentTextTransformStage
	__construct (ServiceOptions $options, LoggerInterface $logger, private readonly bool $transformBodyOnly,)

	transform (ParserOutput $po, ParserOptions $popts, array &$options)
	Transforms the input ParserOutput into the returned ParserOutput.

Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage
	__construct (ServiceOptions $options, LoggerInterface $logger,)

Static Public Member Functions
static	wrapperDivClass (ParserOutput $po, ParserOptions $popts, array $options=[])
	Returns the class name for the wrapper div, or null if no wrapper div should be added.

Protected Member Functions
	transformText (string $text, ParserOutput $po, ParserOptions $popts, array &$options)

Protected Member Functions inherited from MediaWiki\OutputTransform\ContentTextTransformStage
	getFragmentsToTransform (ParserOutput $po, ParserOptions $popts)
	Override this method if you need more control over which fragments should be transformed.

Additional Inherited Members
Public Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
const	CONSTRUCTOR_OPTIONS = []

Protected Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
LoggerInterface	$logger

ServiceOptions	$options

Detailed Description

Wrap the output in a div with the provided class name.

Access: internal

Definition at line 19 of file AddWrapperDivClass.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\OutputTransform\Stages\AddWrapperDivClass::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger,
		private LanguageFactory	$langFactory,
		private Language	$contentLang )

Definition at line 21 of file AddWrapperDivClass.php.

References MediaWiki\OutputTransform\OutputTransformStage\$logger, and MediaWiki\OutputTransform\OutputTransformStage\$options.

Member Function Documentation

◆ shouldRun()

MediaWiki\OutputTransform\Stages\AddWrapperDivClass::shouldRun	(	ParserOutput	$po,
		ParserOptions	$popts,
		array	$options = [] )

Decides whether or not the stage should be run.

Parameters

ParserOutput $po

Stability: unstable

Parameters

ParserOptions	$popts
array	$options

Returns: bool

Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.

Definition at line 43 of file AddWrapperDivClass.php.

◆ transformText()

MediaWiki\OutputTransform\Stages\AddWrapperDivClass::transformText	(	string	$text,
		ParserOutput	$po,
		ParserOptions	$popts,
		array &	$options )

protected

Reimplemented from MediaWiki\OutputTransform\ContentTextTransformStage.

Definition at line 47 of file AddWrapperDivClass.php.

◆ wrapperDivClass()

static MediaWiki\OutputTransform\Stages\AddWrapperDivClass::wrapperDivClass	(	ParserOutput	$po,
		ParserOptions	$popts,
		array	$options = [] )

static

Returns the class name for the wrapper div, or null if no wrapper div should be added.

Definition at line 34 of file AddWrapperDivClass.php.

The documentation for this class was generated from the following file:

includes/OutputTransform/Stages/AddWrapperDivClass.php

Public Member Functions

Static Public Member Functions

Protected Member Functions