REL1_33/php/FileContentHandler_8php_source.html

<?php


class FileContentHandler extends WikitextContentHandler {


    public function getFieldsForSearchIndex( SearchEngine $engine ) {

        $fields['file_media_type'] =

            $engine->makeSearchFieldMapping( 'file_media_type', SearchIndexField::INDEX_TYPE_KEYWORD );

        $fields['file_media_type']->setFlag( SearchIndexField::FLAG_CASEFOLD );

        $fields['file_mime'] =

            $engine->makeSearchFieldMapping( 'file_mime', SearchIndexField::INDEX_TYPE_SHORT_TEXT );

        $fields['file_mime']->setFlag( SearchIndexField::FLAG_CASEFOLD );

        $fields['file_size'] =

            $engine->makeSearchFieldMapping( 'file_size', SearchIndexField::INDEX_TYPE_INTEGER );

        $fields['file_width'] =

            $engine->makeSearchFieldMapping( 'file_width', SearchIndexField::INDEX_TYPE_INTEGER );

        $fields['file_height'] =

            $engine->makeSearchFieldMapping( 'file_height', SearchIndexField::INDEX_TYPE_INTEGER );

        $fields['file_bits'] =

            $engine->makeSearchFieldMapping( 'file_bits', SearchIndexField::INDEX_TYPE_INTEGER );

        $fields['file_resolution'] =

            $engine->makeSearchFieldMapping( 'file_resolution', SearchIndexField::INDEX_TYPE_INTEGER );

        $fields['file_text'] =

            $engine->makeSearchFieldMapping( 'file_text', SearchIndexField::INDEX_TYPE_TEXT );

        return $fields;

    }


    public function getDataForSearchIndex(

        WikiPage $page,

        ParserOutput $parserOutput,

        SearchEngine $engine

    ) {

        $fields = [];


        $title = $page->getTitle();

        if ( NS_FILE != $title->getNamespace() ) {

            return [];

        }

        $file = wfLocalFile( $title );

        if ( !$file || !$file->exists() ) {

            return [];

        }


        $handler = $file->getHandler();

        if ( $handler ) {

            $fields['file_text'] = $handler->getEntireText( $file );

        }

        $fields['file_media_type'] = $file->getMediaType();

        $fields['file_mime'] = $file->getMimeType();

        $fields['file_size'] = $file->getSize();

        $fields['file_width'] = $file->getWidth();

        $fields['file_height'] = $file->getHeight();

        $fields['file_bits'] = $file->getBitDepth();

        $fields['file_resolution'] =

            (int)floor( sqrt( $fields['file_width'] * $fields['file_height'] ) );


        return $fields;

    }


}


and
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two and(2) offer you this license which gives you legal permission to copy

wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition GlobalFunctions.php:2700

FileContentHandler
Content handler for File: files TODO: this handler s not used directly now, but instead manually call...
Definition FileContentHandler.php:9

FileContentHandler\getFieldsForSearchIndex
getFieldsForSearchIndex(SearchEngine $engine)
Get fields definition for search index.
Definition FileContentHandler.php:11

FileContentHandler\getDataForSearchIndex
getDataForSearchIndex(WikiPage $page, ParserOutput $parserOutput, SearchEngine $engine)
Return fields to be indexed by search engine as representation of this document.
Definition FileContentHandler.php:33

ParserOutput
Definition ParserOutput.php:25

SearchEngine
Contain a class for special pages.
Definition SearchEngine.php:34

WikiPage
Class representing a MediaWiki article and history.
Definition WikiPage.php:45

WikitextContentHandler
Content handler for wiki text pages.
Definition WikitextContentHandler.php:33

$handler
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition hooks.txt:894

$engine
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition hooks.txt:2925

NS_FILE
const NS_FILE
Definition Defines.php:79

SearchIndexField\INDEX_TYPE_INTEGER
const INDEX_TYPE_INTEGER
Definition SearchIndexField.php:24

SearchIndexField\INDEX_TYPE_TEXT
const INDEX_TYPE_TEXT
TEXT fields are suitable for natural language and may be subject to analysis such as stemming.
Definition SearchIndexField.php:18

SearchIndexField\INDEX_TYPE_SHORT_TEXT
const INDEX_TYPE_SHORT_TEXT
SHORT_TEXT is meant to be used with short text made of mostly ascii technical information.
Definition SearchIndexField.php:36

SearchIndexField\INDEX_TYPE_KEYWORD
const INDEX_TYPE_KEYWORD
KEYWORD fields are indexed without any processing, so are appropriate for e.g.
Definition SearchIndexField.php:23

SearchIndexField\FLAG_CASEFOLD
const FLAG_CASEFOLD
Generic field flags.
Definition SearchIndexField.php:44