MediaWiki
master
OutputTransformStage.php
Go to the documentation of this file.
1
<?php
2
3
namespace
MediaWiki\OutputTransform
;
4
5
use
MediaWiki\Config\ServiceOptions
;
6
use
MediaWiki\Parser\ParserOptions
;
7
use
MediaWiki\Parser\ParserOutput
;
8
use Psr\Log\LoggerInterface;
9
16
abstract
class
OutputTransformStage
{
17
protected
ServiceOptions
$options
;
18
protected
LoggerInterface
$logger
;
19
21
public
const
CONSTRUCTOR_OPTIONS
= [];
22
24
public
function
__construct
(
ServiceOptions
$options
, LoggerInterface
$logger
) {
25
// Note this is static:: not self:: so we use the subclass options
26
$options
->
assertRequiredOptions
( static::CONSTRUCTOR_OPTIONS );
27
$this->options =
$options
;
28
$this->logger =
$logger
;
29
}
30
39
abstract
public
function
shouldRun
(
ParserOutput
$po, ?
ParserOptions
$popts, array
$options
= [] ): bool;
40
51
abstract
public
function
transform
(
ParserOutput
$po, ?
ParserOptions
$popts, array &
$options
):
ParserOutput
;
52
}
MediaWiki\Config\ServiceOptions
A class for passing options to services.
Definition
ServiceOptions.php:26
MediaWiki\Config\ServiceOptions\assertRequiredOptions
assertRequiredOptions(array $expectedKeys)
Assert that the list of options provided in this instance exactly match $expectedKeys,...
Definition
ServiceOptions.php:70
MediaWiki\OutputTransform\OutputTransformStage
Classes implementing the OutputTransformStage aim at being added to a pipeline of transformations tha...
Definition
OutputTransformStage.php:16
MediaWiki\OutputTransform\OutputTransformStage\shouldRun
shouldRun(ParserOutput $po, ?ParserOptions $popts, array $options=[])
Decides whether or not the stage should be run.
MediaWiki\OutputTransform\OutputTransformStage\$logger
LoggerInterface $logger
Definition
OutputTransformStage.php:18
MediaWiki\OutputTransform\OutputTransformStage\__construct
__construct(ServiceOptions $options, LoggerInterface $logger)
Definition
OutputTransformStage.php:24
MediaWiki\OutputTransform\OutputTransformStage\$options
ServiceOptions $options
Definition
OutputTransformStage.php:17
MediaWiki\OutputTransform\OutputTransformStage\CONSTRUCTOR_OPTIONS
const CONSTRUCTOR_OPTIONS
Definition
OutputTransformStage.php:21
MediaWiki\OutputTransform\OutputTransformStage\transform
transform(ParserOutput $po, ?ParserOptions $popts, array &$options)
Transforms the input ParserOutput into the returned ParserOutput.
MediaWiki\Parser\ParserOptions
Set options of the Parser.
Definition
ParserOptions.php:63
MediaWiki\Parser\ParserOutput
ParserOutput is a rendering of a Content object or a message.
Definition
ParserOutput.php:93
MediaWiki\OutputTransform
Definition
ContentDOMTransformStage.php:3
includes
OutputTransform
OutputTransformStage.php
Generated on Sat Mar 22 2025 19:25:11 for MediaWiki by
1.10.0