FSFile Class Reference

Class representing a non-directory file on the file system. More...

Inheritance diagram for FSFile:

Collaboration diagram for FSFile:

List of all members.

Public Member Functions
	__construct ($path)
	Sets up the file object.
	exists ()
	Checks if the file exists.
	getMimeType ()
	Guess the MIME type from the file contents alone.
	getPath ()
	Returns the file system path.
	getProps ($ext=true)
	Get an associative array containing information about a file with the given storage path.
	getSha1Base36 ($recache=false)
	Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits.
	getSize ()
	Get the file size in bytes.
	getTimestamp ()
	Get the file's last-modified timestamp.
Static Public Member Functions
static	extensionFromPath ($path)
	Get the final file extension from a file system path.
static	getPropsFromPath ($path, $ext=true)
	Get an associative array containing information about a file in the local filesystem.
static	getSha1Base36FromPath ($path)
	Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits.
static	placeholderProps ()
	Placeholder file properties to use for files that don't exist.
Protected Member Functions
	extractImageSizeInfo (array $gis)
	Exract image size information.
Protected Attributes
string	$path
	Path to file *.
string	$sha1Base36
	File SHA-1 in base 36 *.

---

Detailed Description

Class representing a non-directory file on the file system.

Definition at line 29 of file FSFile.php.

---

Constructor & Destructor Documentation

FSFile::__construct

(

$

path

)

Sets up the file object.

Parameters:

string

$path

Path to temporary file on local disk

Reimplemented in TempFSFile.

Definition at line 39 of file FSFile.php.

---

Member Function Documentation

FSFile::exists

(

)

Checks if the file exists.

Returns:

bool

Reimplemented in MockFSFile.

Definition at line 57 of file FSFile.php.

static FSFile::extensionFromPath

(

$

path

)

[static]

Get the final file extension from a file system path.

Parameters:

string

$path

Returns:

string

Definition at line 229 of file FSFile.php.

FSFile::extractImageSizeInfo

(

array $

gis

)

[protected]

Exract image size information.

Parameters:

array

$gis

Returns:

array

Definition at line 177 of file FSFile.php.

FSFile::getMimeType

(

)

Guess the MIME type from the file contents alone.

Returns:

string

Reimplemented in MockFSFile.

Definition at line 91 of file FSFile.php.

FSFile::getPath

(

)

Returns the file system path.

Returns:

string

Definition at line 48 of file FSFile.php.

FSFile::getProps

(

$

ext = true

)

Get an associative array containing information about a file with the given storage path.

Parameters:

string | bool

$ext

The file extension, or true to extract it from the filename. Set it to false to ignore the extension.

Returns:

array

Reimplemented in MockFSFile.

Definition at line 104 of file FSFile.php.

static FSFile::getPropsFromPath	(	$	path,
		$	ext = true
	)		[static]

Get an associative array containing information about a file in the local filesystem.

Parameters:

string	$path	Absolute local filesystem path
string | bool	$ext	The file extension, or true to extract it from the filename. Set it to false to ignore the extension.

Returns:

array

Definition at line 243 of file FSFile.php.

Referenced by UploadBase\verifyFile(), and UploadBase\verifyPartialFile().

FSFile::getSha1Base36

(

$

recache = false

)

Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits.

160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36 fairly neatly.

Parameters:

bool

$recache

Returns:

bool|string False on failure

Reimplemented in MockFSFile.

Definition at line 201 of file FSFile.php.

static FSFile::getSha1Base36FromPath

(

$

path

)

[static]

Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits.

160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36 fairly neatly.

Parameters:

string

$path

Returns:

bool|string False on failure

Definition at line 259 of file FSFile.php.

Referenced by ApiTestCaseUpload\deleteFileByContent(), and UploadBase\getTempFileSha1Base36().

FSFile::getSize

(

)

Get the file size in bytes.

Returns:

int|bool

Reimplemented in MockFSFile.

Definition at line 66 of file FSFile.php.

FSFile::getTimestamp

(

)

Get the file's last-modified timestamp.

Returns:

string|bool TS_MW timestamp or false on failure

Reimplemented in MockFSFile.

Definition at line 75 of file FSFile.php.

static FSFile::placeholderProps

(

)

[static]

Placeholder file properties to use for files that don't exist.

Returns:

array

Definition at line 157 of file FSFile.php.

---

Member Data Documentation

string FSFile::$path [protected]

Path to file *.

Definition at line 30 of file FSFile.php.

Referenced by TempFSFile\__construct().

string FSFile::$sha1Base36 [protected]

File SHA-1 in base 36 *.

Reimplemented in MockFSFile.

Definition at line 32 of file FSFile.php.

---

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

• includes/filebackend/FSFile.php