MediaWiki 1.42.0
|
Class representing a non-directory file on the file system. More...
Inherited by TempFSFile.
Public Member Functions | |
__construct ( $path) | |
Sets up the file object. | |
exists () | |
Checks if the file exists. | |
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 Attributes | |
string | $path |
Path to file. | |
string | $sha1Base36 |
File SHA-1 in base 36. | |
Class representing a non-directory file on the file system.
Definition at line 32 of file FSFile.php.
FSFile::__construct | ( | $path | ) |
Sets up the file object.
string | $path | Path to temporary file on local disk |
Reimplemented in TempFSFile.
Definition at line 44 of file FSFile.php.
References $path.
FSFile::exists | ( | ) |
Checks if the file exists.
Definition at line 62 of file FSFile.php.
Referenced by getProps().
|
static |
Get the final file extension from a file system path.
string | $path |
Definition at line 195 of file FSFile.php.
References $path.
FSFile::getPath | ( | ) |
Returns the file system path.
Definition at line 53 of file FSFile.php.
References $path.
FSFile::getProps | ( | $ext = true | ) |
Get an associative array containing information about a file with the given storage path.
Resulting array fields include:
string | bool | $ext | The file extension, or true to extract it from the filename. Set it to false to ignore the extension. Currently unused. |
Definition at line 112 of file FSFile.php.
References exists(), getSha1Base36(), getSize(), and placeholderProps().
|
static |
Get an associative array containing information about a file in the local filesystem.
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. |
Definition at line 209 of file FSFile.php.
References $path.
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.
bool | $recache |
Definition at line 173 of file FSFile.php.
References $sha1Base36.
Referenced by getProps().
|
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.
string | $path |
Definition at line 225 of file FSFile.php.
References $path.
Referenced by ImportImages\execute(), UploadBase\getTempFileSha1Base36(), and LocalFile\publishTo().
FSFile::getSize | ( | ) |
Get the file size in bytes.
Definition at line 71 of file FSFile.php.
Referenced by getProps().
FSFile::getTimestamp | ( | ) |
Get the file's last-modified timestamp.
Definition at line 84 of file FSFile.php.
|
static |
Placeholder file properties to use for files that don't exist.
Resulting array fields include:
Definition at line 150 of file FSFile.php.
Referenced by FileBackendStore\getFileProps(), getProps(), and MWFileProps\newPlaceholderProps().
|
protected |
Path to file.
Definition at line 34 of file FSFile.php.
Referenced by __construct(), extensionFromPath(), getPath(), getPropsFromPath(), and getSha1Base36FromPath().
|
protected |