Class that stores information about thumbnail, e. More...

Public Member Functions
	__construct (string $mimeType, $size, ?int $width, ?int $height, ?int $duration, string $url, ?string $name)

	getDuration ()
	Duration of the representation in seconds or null if not applicable.

	getHeight ()
	Height of the representation in pixels or null if not applicable.

	getMimeType ()
	Internet mime type for the representation, like "image/png" or "audio/mp3".

	getName ()
	String that represent file identity in storage or null.

	getSize ()

	getUrl ()
	Full URL to the contents of the file.

	getWidth ()
	Width of the representation in pixels or null if not applicable.

Detailed Description

Class that stores information about thumbnail, e.

g. url, width and height

Stability: newable

Definition at line 9 of file SearchResultThumbnail.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\Entity\SearchResultThumbnail::__construct	(	string	$mimeType,
			$size,
		?int	$width,
		?int	$height,
		?int	$duration,
		string	$url,
		?string	$name )

Parameters

string	$mimeType	Internet mime type for the representation, like "image/png" or "audio/mp3"
int \| callable \| null	$size	Size of the representation in bytes. This parameter has been deprecated in 1.41 and will be removed.
int \| null	$width	Width of the representation in pixels or null if not applicable
int \| null	$height	Height of the representation in pixels or null if not applicable
int \| null	$duration	Duration of the representation in seconds or null if not applicable
string	$url	full URL to the contents of the file
string \| null	$name	full URL to the contents of the file

Definition at line 64 of file SearchResultThumbnail.php.

References wfDeprecated().

Member Function Documentation

◆ getDuration()

MediaWiki\Search\Entity\SearchResultThumbnail::getDuration ( )

Duration of the representation in seconds or null if not applicable.

Returns: int|null

Definition at line 138 of file SearchResultThumbnail.php.

◆ getHeight()

MediaWiki\Search\Entity\SearchResultThumbnail::getHeight ( )

Height of the representation in pixels or null if not applicable.

Returns: int|null

Definition at line 107 of file SearchResultThumbnail.php.

◆ getMimeType()

MediaWiki\Search\Entity\SearchResultThumbnail::getMimeType ( )

Internet mime type for the representation, like "image/png" or "audio/mp3".

Returns: string

Definition at line 115 of file SearchResultThumbnail.php.

◆ getName()

MediaWiki\Search\Entity\SearchResultThumbnail::getName ( )

String that represent file identity in storage or null.

Returns: string|null

Definition at line 146 of file SearchResultThumbnail.php.

◆ getSize()

MediaWiki\Search\Entity\SearchResultThumbnail::getSize ( )

Deprecated: since 1.41, Do not use, resource intensive and thus degrade performance.

Size of the representation in bytes or null if not applicable

Returns: int|null

Definition at line 126 of file SearchResultThumbnail.php.

◆ getUrl()

MediaWiki\Search\Entity\SearchResultThumbnail::getUrl ( )

Full URL to the contents of the file.

Returns: string

Definition at line 91 of file SearchResultThumbnail.php.

◆ getWidth()

MediaWiki\Search\Entity\SearchResultThumbnail::getWidth ( )

Width of the representation in pixels or null if not applicable.

Returns: int|null

Definition at line 99 of file SearchResultThumbnail.php.

The documentation for this class was generated from the following file:

includes/search/Entity/SearchResultThumbnail.php

Public Member Functions