0ffe341629
== Ungroup file blocks Remove `@ingroup` from `@file` blocks and keep only the class block. This matches similar changes previously applied to API, Skins, Profile, and ResourceLoader. This helps make the API documentation easier to navigate. E.g. Modules -> Language in the sidebar of <https://doc.wikimedia.org/mediawiki-core/master/php/> as well as <https://doc.wikimedia.org/mediawiki-core/master/php/group__Language.html> These are currently cluttered with tons of duplicate entries for files and classes both. We only need to group files that aren't also documented as a class (e.g. message files, entry points, other scripts or files that we mainly consider a data file). This has the helpful side-effect that we don't encourage duplication of the class description (or worse, place useful docs only in the file block), and makes the class files consistently start with a mentally ignorable block. Basically, unless there's something other than a class, don't describe or group the file itself. == Missing group Various classes in this subtree were missing the `Language` group, or were using different group from before T225756. == Subgroup For ease of navigation, move Converter subclasses to a group called "Languages", which for documentation purposes is a subgroup of "Language". The next commit does the same for Messages* files, and Language subclasses (done separately for ease of review). Change-Id: I301f471f86ba2dee924fece29a16dc3c20b5bebe
100 lines
2.5 KiB
PHP
100 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use Wikimedia\AtEase\AtEase;
|
|
|
|
/**
|
|
* Depend on a file.
|
|
*
|
|
* @newable
|
|
* @ingroup Language
|
|
*/
|
|
class FileDependency extends CacheDependency {
|
|
private $filename;
|
|
private $timestamp;
|
|
|
|
/**
|
|
* Create a file dependency
|
|
*
|
|
* @stable to call
|
|
*
|
|
* @param string $filename The name of the file, preferably fully qualified
|
|
* @param null|bool|int $timestamp The unix last modified timestamp, or false if the
|
|
* file does not exist. If omitted, the timestamp will be loaded from
|
|
* the file.
|
|
*
|
|
* A dependency on a nonexistent file will be triggered when the file is
|
|
* created. A dependency on an existing file will be triggered when the
|
|
* file is changed.
|
|
*/
|
|
public function __construct( $filename, $timestamp = null ) {
|
|
$this->filename = $filename;
|
|
$this->timestamp = $timestamp;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function __sleep() {
|
|
$this->loadDependencyValues();
|
|
|
|
return [ 'filename', 'timestamp' ];
|
|
}
|
|
|
|
public function loadDependencyValues() {
|
|
if ( $this->timestamp === null ) {
|
|
AtEase::suppressWarnings();
|
|
# Dependency on a non-existent file stores "false"
|
|
# This is a valid concept!
|
|
$this->timestamp = filemtime( $this->filename );
|
|
AtEase::restoreWarnings();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isExpired() {
|
|
AtEase::suppressWarnings();
|
|
$lastmod = filemtime( $this->filename );
|
|
AtEase::restoreWarnings();
|
|
if ( $lastmod === false ) {
|
|
if ( $this->timestamp === false ) {
|
|
# Still nonexistent
|
|
return false;
|
|
}
|
|
|
|
# Deleted
|
|
wfDebug( "Dependency triggered: {$this->filename} deleted." );
|
|
|
|
return true;
|
|
}
|
|
|
|
if ( $lastmod > $this->timestamp ) {
|
|
# Modified or created
|
|
wfDebug( "Dependency triggered: {$this->filename} changed." );
|
|
|
|
return true;
|
|
}
|
|
|
|
# Not modified
|
|
return false;
|
|
}
|
|
}
|