SpecialFilepath.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Search\SearchEngineFactory;
use MediaWiki\SpecialPage\RedirectSpecialPage;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
 
class SpecialFilepath extends RedirectSpecialPage {
 
    public function __construct(
        private readonly SearchEngineFactory $searchEngineFactory,
    ) {
        parent::__construct( 'Filepath' );
        $this->mAllowedRedirectParams = [ 'width', 'height' ];
    }
 
    public function getRedirect( $par ) {
        $file = $par ?: $this->getRequest()->getText( 'file' );
 
        $redirect = null;
        if ( $file ) {
            $redirect = SpecialPage::getSafeTitleFor( 'Redirect', "file/$file" );
        }
        if ( $redirect === null ) {
            // The user input is empty or an invalid title,
            // redirect to form of Special:Redirect with the invalid value prefilled
            $this->mAddedRedirectParams['wpvalue'] = $file;
            $redirect = SpecialPage::getSafeTitleFor( 'Redirect', 'file' );
        }
        // @phan-suppress-next-line PhanTypeMismatchReturnNullable Known to be valid
        return $redirect;
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $title = Title::newFromText( $search, NS_FILE );
        if ( !$title || $title->getNamespace() !== NS_FILE ) {
            // No prefix suggestion outside of file namespace
            return [];
        }
        $searchEngine = $this->searchEngineFactory->create();
        $searchEngine->setLimitOffset( $limit, $offset );
        // Autocomplete subpage the same as a normal search, but just for files
        $searchEngine->setNamespaces( [ NS_FILE ] );
        $result = $searchEngine->defaultPrefixSearch( $search );
 
        return array_map( static function ( Title $t ) {
            // Remove namespace in search suggestion
            return $t->getText();
        }, $result );
    }
 
    protected function getGroupName() {
        return 'media';
    }
}
 
// @codeCoverageIgnoreStart
class_alias( SpecialFilepath::class, 'SpecialFilepath' );
// @codeCoverageIgnoreEnd