|
MediaWiki master
|
Wrap the output in a div with the provided class name. More...
Inherits MediaWiki\OutputTransform\OutputTransformStage.

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. | |
| 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. | |
Additional Inherited Members | |
| Public Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage | |
| const | CONSTRUCTOR_OPTIONS = [] |
| Protected Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage | |
| LoggerInterface | $logger |
| ServiceOptions | $options |
Wrap the output in a div with the provided class name.
Definition at line 20 of file AddWrapperDivClass.php.
| MediaWiki\OutputTransform\Stages\AddWrapperDivClass::__construct | ( | ServiceOptions | $options, |
| LoggerInterface | $logger, | ||
| private LanguageFactory | $langFactory, | ||
| private Language | $contentLang ) |
Definition at line 22 of file AddWrapperDivClass.php.
References MediaWiki\OutputTransform\OutputTransformStage\$logger, and MediaWiki\OutputTransform\OutputTransformStage\$options.
| MediaWiki\OutputTransform\Stages\AddWrapperDivClass::shouldRun | ( | ParserOutput | $po, |
| ParserOptions | $popts, | ||
| array | $options = [] ) |
Decides whether or not the stage should be run.
| ParserOutput | $po |
| ParserOptions | $popts | |
| array | $options |
Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.
Definition at line 44 of file AddWrapperDivClass.php.
References MediaWiki\OutputTransform\OutputTransformStage\$options, return, and wrapperDivClass().
| MediaWiki\OutputTransform\Stages\AddWrapperDivClass::transform | ( | ParserOutput | $po, |
| ParserOptions | $popts, | ||
| array & | $options ) |
Transforms the input ParserOutput into the returned ParserOutput.
The returned ParserOutput can explicitly be a modified version of the input ParserOutput; if modifications to that object are unexpected, a copy should be made before passing it to this method. TODO Some transformations require the possibility of modifying options (this is the case of ExecutePostCacheTransformHooks in particular). We do NOT want to keep this mechanism for later versions of this interface - the currently foreseen goal is to not pass $options at all. Modifying $options during this pass is considered deprecated.
Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.
Definition at line 48 of file AddWrapperDivClass.php.
References MediaWiki\OutputTransform\OutputTransformStage\$options, and wrapperDivClass().
|
static |
Returns the class name for the wrapper div, or null if no wrapper div should be added.
Definition at line 35 of file AddWrapperDivClass.php.
References MediaWiki\OutputTransform\OutputTransformStage\$options.
Referenced by shouldRun(), and transform().