ThumbnailImage.php

Go to the documentation of this file.

<?php
 
use MediaWiki\FileRepo\File\File;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Html\Html;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use MediaWiki\Xml\Xml;
 
class ThumbnailImage extends MediaTransformOutput {
    public function __construct( $file, $url, $path = false, $parameters = [] ) {
        // Previous parameters:
        //   $file, $url, $width, $height, $path = false, $page = false
 
        $defaults = [
            'page' => false,
            'lang' => false
        ];
 
        if ( is_array( $parameters ) ) {
            $actualParams = $parameters + $defaults;
        } else {
            // Using old format, should convert. Later a warning could be added here.
            $numArgs = func_num_args();
            $actualParams = [
                'width' => $path,
                'height' => $parameters,
                'page' => ( $numArgs > 5 ) ? func_get_arg( 5 ) : false
            ] + $defaults;
            $path = ( $numArgs > 4 ) ? func_get_arg( 4 ) : false;
        }
 
        $this->file = $file;
        $this->url = $url;
        $this->path = $path;
 
        // These should be integers when they get here.
        // If not, there's a bug somewhere.  But let's at
        // least produce valid HTML code regardless.
        // @phan-suppress-next-line PhanTypeMismatchArgumentInternal Confused by old signature
        $this->width = (int)round( $actualParams['width'] );
        $this->height = (int)round( $actualParams['height'] );
 
        $this->page = $actualParams['page'];
        $this->lang = $actualParams['lang'];
    }
 
    public function toHtml( $options = [] ) {
        $services = MediaWikiServices::getInstance();
        $mainConfig = $services->getMainConfig();
        $nativeImageLazyLoading = $mainConfig->get( MainConfigNames::NativeImageLazyLoading );
        $enableLegacyMediaDOM = $mainConfig->get( MainConfigNames::ParserEnableLegacyMediaDOM );
 
        if ( func_num_args() === 2 ) {
            throw new InvalidArgumentException( __METHOD__ . ' called in the old style' );
        }
 
        $query = $options['desc-query'] ?? '';
 
        $attribs = [];
 
        // An empty alt indicates an image is not a key part of the content and
        // that non-visual browsers may omit it from rendering.  Only set the
        // parameter if it's explicitly requested.
        if ( isset( $options['alt'] ) ) {
            $attribs['alt'] = $options['alt'];
        }
 
        // Description links get the mw-file-description class and link
        // to the file description page, making the resource redundant
        if (
            !$enableLegacyMediaDOM &&
            isset( $options['magnify-resource'] ) &&
            !( $options['desc-link'] ?? false )
        ) {
            $attribs['resource'] = $options['magnify-resource'];
        }
 
        $attribs += [
            'src' => $this->url,
            'decoding' => 'async',
        ];
 
        if ( $options['loading'] ?? $nativeImageLazyLoading ) {
            $attribs['loading'] = $options['loading'] ?? 'lazy';
        }
 
        if ( !empty( $options['custom-url-link'] ) ) {
            $linkAttribs = [ 'href' => $options['custom-url-link'] ];
            if ( !empty( $options['title'] ) ) {
                $linkAttribs['title'] = $options['title'];
            }
            if ( !empty( $options['custom-target-link'] ) ) {
                $linkAttribs['target'] = $options['custom-target-link'];
            } elseif ( !empty( $options['parser-extlink-target'] ) ) {
                $linkAttribs['target'] = $options['parser-extlink-target'];
            }
            if ( !empty( $options['parser-extlink-rel'] ) ) {
                $linkAttribs['rel'] = $options['parser-extlink-rel'];
            }
        } elseif ( !empty( $options['custom-title-link'] ) ) {
            $title = $options['custom-title-link'];
            $linkAttribs = [
                'href' => $title->getLinkURL( $options['custom-title-link-query'] ?? null ),
                'title' => empty( $options['title'] ) ? $title->getPrefixedText() : $options['title']
            ];
        } elseif ( !empty( $options['desc-link'] ) ) {
            $linkAttribs = $this->getDescLinkAttribs(
                empty( $options['title'] ) ? null : $options['title'],
                $query
            );
        } elseif ( !empty( $options['file-link'] ) ) {
            $linkAttribs = [ 'href' => $this->file->getUrl() ];
        } else {
            $linkAttribs = false;
            if ( !empty( $options['title'] ) ) {
                if ( $enableLegacyMediaDOM ) {
                    $attribs['title'] = $options['title'];
                } else {
                    $linkAttribs = [ 'title' => $options['title'] ];
                }
            }
        }
 
        if ( empty( $options['no-dimensions'] ) ) {
            $attribs['width'] = $this->width;
            $attribs['height'] = $this->height;
        }
        if ( !empty( $options['valign'] ) ) {
            $attribs['style'] = "vertical-align: {$options['valign']}";
        }
        if ( !empty( $options['img-class'] ) ) {
            $attribs['class'] = $options['img-class'];
        }
        if ( isset( $options['override-height'] ) ) {
            $attribs['height'] = $options['override-height'];
        }
        if ( isset( $options['override-width'] ) ) {
            $attribs['width'] = $options['override-width'];
        }
 
        // Additional densities for responsive images, if specified.
        // If any of these urls is the same as src url, it'll be excluded.
        $responsiveUrls = array_diff( $this->responsiveUrls, [ $this->url ] );
        if ( $responsiveUrls ) {
            $attribs['srcset'] = Html::srcSet( $responsiveUrls );
        }
 
        ( new HookRunner( $services->getHookContainer() ) )
            ->onThumbnailBeforeProduceHTML( $this, $attribs, $linkAttribs );
 
        return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) );
    }
}