FakeDimensionFile Class Reference

Media More...

Inheritance diagram for FakeDimensionFile:

Collaboration diagram for FakeDimensionFile:

List of all members.

Public Member Functions
	__construct ($dimensions)
	getHeight ($page=1)
	Return the height of the image.
	getPath ()
	Return the storage path to the file.
	getWidth ($page=1)
	Return the width of the image.
	mustRender ()
	Return true if the file is of a type that can't be directly rendered by typical browsers and needs to be re-rasterized.
Public Attributes
	$mustRender = false

---

Detailed Description

Media

Definition at line 6 of file FakeDimensionFile.php.

---

Constructor & Destructor Documentation

FakeDimensionFile::__construct

(

$

dimensions

)

Definition at line 9 of file FakeDimensionFile.php.

References Title\makeTitle().

---

Member Function Documentation

FakeDimensionFile::getHeight

(

$

page = 1

)

Return the height of the image.

Returns false if the height is unknown or undefined

STUB Overridden by LocalFile, UnregisteredLocalFile

Parameters:

int

$page

Returns:

bool|int False on failure

Reimplemented from File.

Definition at line 20 of file FakeDimensionFile.php.

FakeDimensionFile::getPath

(

)

Return the storage path to the file.

Note that this does not mean that a file actually exists under that location.

This path depends on whether directory hashing is active or not, i.e. whether the files are all found in the same directory, or in hashed paths like /images/3/3c.

Most callers don't check the return value, but ForeignAPIFile::getPath returns false.

Returns:

string|bool ForeignAPIFile::getPath can return false

Reimplemented from File.

Definition at line 28 of file FakeDimensionFile.php.

FakeDimensionFile::getWidth

(

$

page = 1

)

Return the width of the image.

Returns false if the width is unknown or undefined.

STUB Overridden by LocalFile, UnregisteredLocalFile

Parameters:

int

$page

Returns:

int|bool

Reimplemented from File.

Definition at line 16 of file FakeDimensionFile.php.

FakeDimensionFile::mustRender

(

)

Return true if the file is of a type that can't be directly rendered by typical browsers and needs to be re-rasterized.

This returns true for everything but the bitmap types supported by all browsers, i.e. JPEG; GIF and PNG. It will also return true for any non-image formats.

Returns:

bool

Reimplemented from File.

Definition at line 24 of file FakeDimensionFile.php.

---

Member Data Documentation

FakeDimensionFile::$mustRender = false

Definition at line 7 of file FakeDimensionFile.php.

---

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

• tests/phpunit/includes/media/FakeDimensionFile.php