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
68 lines
2.2 KiB
PHP
68 lines
2.2 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
|
|
*/
|
|
|
|
/**
|
|
* Interface for the persistence layer of LocalisationCache.
|
|
*
|
|
* The persistence layer is two-level hierarchical cache. The first level
|
|
* is the language, the second level is the item or subitem.
|
|
*
|
|
* Since the data for a whole language is rebuilt in one operation, it needs
|
|
* to have a fast and atomic method for deleting or replacing all of the
|
|
* current data for a given language. The interface reflects this bulk update
|
|
* operation. Callers writing to the cache must first call startWrite(), then
|
|
* will call set() a couple of thousand times, then will call finishWrite()
|
|
* to commit the operation. When finishWrite() is called, the cache is
|
|
* expected to delete all data previously stored for that language.
|
|
*
|
|
* The values stored are PHP variables suitable for serialize(). Implementations
|
|
* of LCStore are responsible for serializing and unserializing.
|
|
*
|
|
* @ingroup Language
|
|
*/
|
|
interface LCStore {
|
|
|
|
/**
|
|
* Get a value.
|
|
* @param string $code Language code
|
|
* @param string $key Cache key
|
|
*/
|
|
public function get( $code, $key );
|
|
|
|
/**
|
|
* Start a write transaction.
|
|
* @param string $code Language code
|
|
*/
|
|
public function startWrite( $code );
|
|
|
|
/**
|
|
* Finish a write transaction.
|
|
*/
|
|
public function finishWrite();
|
|
|
|
/**
|
|
* Set a key to a given value. startWrite() must be called before this
|
|
* is called, and finishWrite() must be called afterwards.
|
|
* @param string $key
|
|
* @param mixed $value
|
|
*/
|
|
public function set( $key, $value );
|
|
|
|
}
|