ResourceLoaderLessVarFileModule.php

Go to the documentation of this file.

<?php
// Per https://phabricator.wikimedia.org/T241091
// phpcs:disable MediaWiki.Commenting.FunctionAnnotations.UnrecognizedAnnotation
 
class ResourceLoaderLessVarFileModule extends ResourceLoaderFileModule {
    protected $lessVariables = [];
 
    public function __construct(
        array $options = [],
        $localBasePath = null,
        $remoteBasePath = null
    ) {
        if ( isset( $options['lessMessages'] ) ) {
            $this->lessVariables = $options['lessMessages'];
        }
        parent::__construct( $options, $localBasePath, $remoteBasePath );
    }
 
    public function getMessages() {
        // Overload so MessageBlobStore can detect updates to messages and purge as needed.
        return array_merge( $this->messages, $this->lessVariables );
    }
 
    private function pluckFromMessageBlob( $blob, array $whitelist ) : array {
        $data = json_decode( $blob, true );
        // Keep only the messages intended for LESS export
        // (opposite of getMesssages essentially).
        return array_intersect_key( $data, array_flip( $whitelist ) );
    }
 
    protected function getMessageBlob( ResourceLoaderContext $context ) {
        $blob = parent::getMessageBlob( $context );
        return json_encode( (object)$this->pluckFromMessageBlob( $blob, $this->messages ) );
    }
 
    // phpcs:disable MediaWiki.Commenting.DocComment.SpacingDocTag, Squiz.WhiteSpace.FunctionSpacing.Before
    private static function wrapAndEscapeMessage( $msg ) {
        return str_replace( "'", "\'", CSSMin::serializeStringValue( $msg ) );
    }
 
    // phpcs:enable MediaWiki.Commenting.DocComment.SpacingDocTag, Squiz.WhiteSpace.FunctionSpacing.Before
 
    protected function getLessVars( ResourceLoaderContext $context ) {
        $blob = parent::getMessageBlob( $context );
        $messages = $this->pluckFromMessageBlob( $blob, $this->lessVariables );
 
        $vars = parent::getLessVars( $context );
        foreach ( $messages as $msgKey => $value ) {
            $vars['msg-' . $msgKey] = self::wrapAndEscapeMessage( $value );
        }
        return $vars;
    }
}