Page MenuHomeWickedGov Phorge
Files F5987009

RendererFactory.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

RendererFactory.php
View Options

<?php
namespace MediaWiki\Extension\Math\Render;
use InvalidArgumentException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Extension\Math\MathConfig;
use MediaWiki\Extension\Math\MathLaTeXML;
use MediaWiki\Extension\Math\MathMathML;
use MediaWiki\Extension\Math\MathMathMLCli;
use MediaWiki\Extension\Math\MathNativeMML;
use MediaWiki\Extension\Math\MathRenderer;
use MediaWiki\Extension\Math\MathSource;
use MediaWiki\User\Options\UserOptionsLookup;
use Psr\Log\LoggerInterface;
use Wikimedia\ObjectCache\WANObjectCache;
class RendererFactory {
/** @var string[] */
public const CONSTRUCTOR_OPTIONS = [
'MathoidCli',
'MathEnableExperimentalInputFormats',
'MathValidModes',
];
/** @var ServiceOptions */
private $options;
/** @var UserOptionsLookup */
private $userOptionsLookup;
/** @var MathConfig */
private $mathConfig;
/** @var LoggerInterface */
private $logger;
private WANObjectCache $cache;
/**
* @param ServiceOptions $serviceOptions
* @param MathConfig $mathConfig
* @param UserOptionsLookup $userOptionsLookup
* @param LoggerInterface $logger
* @param WANObjectCache $cache
*/
public function __construct(
ServiceOptions $serviceOptions,
MathConfig $mathConfig,
UserOptionsLookup $userOptionsLookup,
LoggerInterface $logger,
WANObjectCache $cache
) {
$serviceOptions->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->options = $serviceOptions;
$this->mathConfig = $mathConfig;
$this->userOptionsLookup = $userOptionsLookup;
$this->logger = $logger;
$this->cache = $cache;
}
/**
* Determine mode used for rendering of math equation, based on current configuration and tag received
*
* @param string $mode
* @param array $params
* @return array Returns one of the predefined MathConfig::MODE_* constants and params changed according to rules
*/
public function determineMode(
string $mode = MathConfig::MODE_MATHML,
array $params = []
): array {
if ( isset( $params['forcemathmode'] ) ) {
$mode = $params['forcemathmode'];
}
if ( !in_array( $mode, $this->mathConfig->getValidRenderingModes(), true ) ) {
$mode = $this->userOptionsLookup->getDefaultOption( 'math' );
}
if ( $this->options->get( 'MathEnableExperimentalInputFormats' ) === true &&
$mode == MathConfig::MODE_MATHML &&
isset( $params['type'] )
) {
// Support of MathML input (experimental)
// Currently support for mode 'mathml' only
if ( !in_array( $params['type'], [ 'pmml', 'ascii' ], true ) ) {
unset( $params['type'] );
}
}
if ( isset( $params['chem'] ) ) {
$mode = ( $mode == MathConfig::MODE_NATIVE_MML ) ? MathConfig::MODE_NATIVE_MML : MathConfig::MODE_MATHML;
$params['type'] = 'chem';
}
return [ $mode, $params ];
}
/**
* Factory method for getting a renderer based on mode
*
* @param string $tex LaTeX markup
* @param array $params HTML attributes
* @param string $mode indicating rendering mode, one of MathConfig::MODE_*
* @return MathRenderer appropriate renderer for mode
*/
public function getRenderer(
string $tex,
array $params = [],
string $mode = MathConfig::MODE_MATHML
): MathRenderer {
[ $mode, $params ] = $this->determineMode( $mode, $params );
switch ( $mode ) {
case MathConfig::MODE_SOURCE:
$renderer = new MathSource( $tex, $params );
break;
case MathConfig::MODE_NATIVE_MML:
$renderer = new MathNativeMML( $tex, $params, $this->cache );
break;
case MathConfig::MODE_LATEXML:
$renderer = new MathLaTeXML( $tex, $params, $this->cache );
break;
case MathConfig::MODE_MATHML:
default:
if ( $this->options->get( 'MathoidCli' ) ) {
$renderer = new MathMathMLCli( $tex, $params, $this->cache );
} else {
$renderer = new MathMathML( $tex, $params, $this->cache );
}
}
$this->logger->debug(
'Start rendering "{tex}" in mode {mode}',
[
'tex' => $tex,
'mode' => $mode
]
);
return $renderer;
}
public function getFromHash( string $inputHash ): MathRenderer {
$key = $this->cache->makeGlobalKey(
MathRenderer::class,
$inputHash
);
$rpage = $this->cache->get( $key );
if ( $rpage === false ) {
throw new InvalidArgumentException( 'Cache key is invalid' );
}
$mode = $rpage['math_mode'];
$renderer = $this->getRenderer( '', [], $mode );
$renderer->initializeFromCache( $rpage );
return $renderer;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sun, Oct 4, 00:17 (2 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b2/3d/0e5f0048bdf61c43b376d6ae69af
Default Alt Text
RendererFactory.php (4 KB)

Event Timeline