MediaWiki REL1_35
Public Member Functions | Private Attributes | List of all members
MediaWiki\Search\Entity\SearchResultThumbnail Class Reference

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

Public Member Functions

 __construct (string $mimeType, ?int $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 indentity in storage or null.
 
 getSize ()
 Size of the representation in bytes or null if not applicable.
 
 getUrl ()
 Full URL to the contents of the file.
 
 getWidth ()
 Width of the representation in pixels or null if not applicable.
 

Private Attributes

int null $duration
 Duration of the representation in seconds or null if not applicable.
 
int null $height
 Height of the representation in pixels or null if not applicable.
 
string $mimeType
 Internet mime type for the representation, like "image/png" or "audio/mp3".
 
string null $name
 String that represent file indentity in storage or null.
 
int null $size
 Size of the representation in bytes or null if not applicable.
 
string $url
 Full URL to the contents of the file.
 
int null $width
 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 @newable

Definition at line 9 of file SearchResultThumbnail.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\Entity\SearchResultThumbnail::__construct ( string  $mimeType,
?int  $size,
?int  $width,
?int  $height,
?int  $duration,
string  $url,
?string  $name 
)
Parameters
string$mimeTypeInternet mime type for the representation, like "image/png" or "audio/mp3"
int | null$sizeSize of the representation in bytes
int | null$widthWidth of the representation in pixels or null if not applicable
int | null$heightHeight of the representation in pixels or null if not applicable
int | null$durationDuration of the representation in seconds or null if not applicable
string$urlfull URL to the contents of the file
string | null$namefull URL to the contents of the file

Definition at line 63 of file SearchResultThumbnail.php.

References MediaWiki\Search\Entity\SearchResultThumbnail\$duration, MediaWiki\Search\Entity\SearchResultThumbnail\$height, MediaWiki\Search\Entity\SearchResultThumbnail\$mimeType, MediaWiki\Search\Entity\SearchResultThumbnail\$name, MediaWiki\Search\Entity\SearchResultThumbnail\$size, MediaWiki\Search\Entity\SearchResultThumbnail\$url, and MediaWiki\Search\Entity\SearchResultThumbnail\$width.

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 125 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 101 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 109 of file SearchResultThumbnail.php.

◆ getName()

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

String that represent file indentity in storage or null.

Returns
string|null

Definition at line 133 of file SearchResultThumbnail.php.

◆ getSize()

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

Size of the representation in bytes or null if not applicable.

Returns
int|null

Definition at line 117 of file SearchResultThumbnail.php.

◆ getUrl()

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

Full URL to the contents of the file.

Returns
string

Definition at line 85 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 93 of file SearchResultThumbnail.php.

Member Data Documentation

◆ $duration

int null MediaWiki\Search\Entity\SearchResultThumbnail::$duration
private

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

Definition at line 26 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

◆ $height

int null MediaWiki\Search\Entity\SearchResultThumbnail::$height
private

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

Definition at line 44 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

◆ $mimeType

string MediaWiki\Search\Entity\SearchResultThumbnail::$mimeType
private

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

Definition at line 14 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

◆ $name

string null MediaWiki\Search\Entity\SearchResultThumbnail::$name
private

String that represent file indentity in storage or null.

Definition at line 50 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

◆ $size

int null MediaWiki\Search\Entity\SearchResultThumbnail::$size
private

Size of the representation in bytes or null if not applicable.

Definition at line 20 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

◆ $url

string MediaWiki\Search\Entity\SearchResultThumbnail::$url
private

Full URL to the contents of the file.

Definition at line 32 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

◆ $width

int null MediaWiki\Search\Entity\SearchResultThumbnail::$width
private

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

Definition at line 38 of file SearchResultThumbnail.php.

Referenced by MediaWiki\Search\Entity\SearchResultThumbnail\__construct().

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