GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • includes
  • libs
  • FileBackend
  • FSFile
  • FSFile.php

This view

  • Original page
  • New address

GeezerVison is showing doc.wikimedia.org — MediaWiki: includes/libs/FileBackend/FSFile/FSFile.php Source File

MediaWiki master
Toggle main menu visibility
FSFile.php
Go to the documentation of this file.
1<?php
9
10namespace Wikimedia\FileBackend\FSFile;
11
12use Wikimedia\Timestamp\ConvertibleTimestamp;
13use Wikimedia\Timestamp\TimestampFormat as TS;
14
20class FSFile {
22 protected $path;
23
25 protected $sha1Base36;
26
32 public function __construct( $path ) {
33 $this->path = $path;
34 }
35
41 public function getPath() {
42 return $this->path;
43 }
44
50 public function exists() {
51 return is_file( $this->path );
52 }
53
59 public function getSize() {
60 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
61 return @filesize( $this->path );
62 }
63
69 public function getTimestamp() {
70 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
71 $timestamp = @filemtime( $this->path );
72 if ( $timestamp !== false ) {
73 $timestamp = ConvertibleTimestamp::convert( TS::MW, $timestamp );
74 }
75
76 return $timestamp;
77 }
78
96 public function getProps( $ext = true ) {
97 $info = self::placeholderProps();
98 $info['fileExists'] = $this->exists();
99
100 if ( $info['fileExists'] ) {
101 $info['size'] = $this->getSize(); // bytes
102 $info['sha1'] = $this->getSha1Base36();
103
104 $mime = mime_content_type( $this->path );
105 # MIME type according to file contents
106 $info['file-mime'] = ( $mime === false ) ? 'unknown/unknown' : $mime;
107 # logical MIME type
108 $info['mime'] = $mime;
109
110 if ( str_contains( $mime, '/' ) ) {
111 [ $info['major_mime'], $info['minor_mime'] ] = explode( '/', $mime, 2 );
112 } else {
113 [ $info['major_mime'], $info['minor_mime'] ] = [ $mime, 'unknown' ];
114 }
115 }
116
117 return $info;
118 }
119
134 public static function placeholderProps() {
135 return [
136 'fileExists' => false,
137 'size' => 0,
138 'file-mime' => null,
139 'major_mime' => null,
140 'minor_mime' => null,
141 'mime' => null,
142 'sha1' => '',
143 ];
144 }
145
156 public function getSha1Base36( $recache = false ) {
157 if ( $this->sha1Base36 !== null && !$recache ) {
158 return $this->sha1Base36;
159 }
160
161 // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
162 $this->sha1Base36 = @sha1_file( $this->path );
163
164 if ( $this->sha1Base36 !== false ) {
165 $this->sha1Base36 = \Wikimedia\base_convert( $this->sha1Base36, 16, 36, 31 );
166 }
167
168 return $this->sha1Base36;
169 }
170
178 public static function extensionFromPath( $path ) {
179 wfDeprecated( __METHOD__, '1.47' );
180
181 $i = strrpos( $path, '.' );
182
183 return strtolower( $i ? substr( $path, $i + 1 ) : '' );
184 }
185
194 public static function getPropsFromPath( $path, $ext = true ) {
195 $fsFile = new self( $path );
196
197 return $fsFile->getProps( $ext );
198 }
199
210 public static function getSha1Base36FromPath( $path ) {
211 $fsFile = new self( $path );
212
213 return $fsFile->getSha1Base36();
214 }
215}
216
218class_alias( FSFile::class, 'FSFile' );
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that a deprecated feature was used.
Definition GlobalFunctions.php:463
Wikimedia\FileBackend\FSFile\FSFile
Class representing a non-directory file on the file system.
Definition FSFile.php:20
Wikimedia\FileBackend\FSFile\FSFile\$sha1Base36
string $sha1Base36
File SHA-1 in base 36.
Definition FSFile.php:25
Wikimedia\FileBackend\FSFile\FSFile\$path
string $path
Path to file.
Definition FSFile.php:22
Wikimedia\FileBackend\FSFile\FSFile\getPath
getPath()
Returns the file system path.
Definition FSFile.php:41
Wikimedia\FileBackend\FSFile\FSFile\getTimestamp
getTimestamp()
Get the file's last-modified timestamp.
Definition FSFile.php:69
Wikimedia\FileBackend\FSFile\FSFile\__construct
__construct( $path)
Sets up the file object.
Definition FSFile.php:32
Wikimedia\FileBackend\FSFile\FSFile\getSha1Base36
getSha1Base36( $recache=false)
Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding,...
Definition FSFile.php:156
Wikimedia\FileBackend\FSFile\FSFile\getSize
getSize()
Get the file size in bytes.
Definition FSFile.php:59
Wikimedia\FileBackend\FSFile\FSFile\getPropsFromPath
static getPropsFromPath( $path, $ext=true)
Get an associative array containing information about a file in the local filesystem.
Definition FSFile.php:194
Wikimedia\FileBackend\FSFile\FSFile\getSha1Base36FromPath
static getSha1Base36FromPath( $path)
Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding,...
Definition FSFile.php:210
Wikimedia\FileBackend\FSFile\FSFile\extensionFromPath
static extensionFromPath( $path)
Get the final file extension from a file system path.
Definition FSFile.php:178
Wikimedia\FileBackend\FSFile\FSFile\getProps
getProps( $ext=true)
Get an associative array containing information about a file with the given storage path.
Definition FSFile.php:96
Wikimedia\FileBackend\FSFile\FSFile\placeholderProps
static placeholderProps()
Placeholder file properties to use for files that don't exist.
Definition FSFile.php:134
Wikimedia\FileBackend\FSFile\FSFile\exists
exists()
Checks if the file exists.
Definition FSFile.php:50
Wikimedia\FileBackend\FSFile
Definition FSFile.php:10
  • includes
  • libs
  • FileBackend
  • FSFile
  • FSFile.php
  • Generated on for MediaWiki by doxygen 1.18.0
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.