Aude has uploaded a new change for review. https://gerrit.wikimedia.org/r/177098
Change subject: Add documentation for SiteListFileCache ...................................................................... Add documentation for SiteListFileCache Change-Id: I6c5b7fdfbbd6a4e6d67bd0f4aff539ce4d97cfda --- M includes/site/SiteListFileCache.php 1 file changed, 13 insertions(+), 3 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core refs/changes/98/177098/1 diff --git a/includes/site/SiteListFileCache.php b/includes/site/SiteListFileCache.php index c0ecab1..ee3ebfe 100644 --- a/includes/site/SiteListFileCache.php +++ b/includes/site/SiteListFileCache.php @@ -1,5 +1,4 @@ <?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 @@ -16,11 +15,18 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html * - * @since 1.25 - * * @file * * @license GNU GPL v2+ + */ + +/** + * Provides a file-based cache of a SiteStore, stored as a json file. + * The cache can be built with the rebuildSitesCache.php maintenance script, + * and a MediaWiki instance can be setup to use this by setting the + * 'wgSitesCacheFile' configuration to the cache file location. + * + * @since 1.25 */ class SiteListFileCache { @@ -55,7 +61,11 @@ } /** + * @param string $globalId + * * @since 1.25 + * + * @return Site */ public function getSite( $globalId ) { $sites = $this->getSites(); -- To view, visit https://gerrit.wikimedia.org/r/177098 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I6c5b7fdfbbd6a4e6d67bd0f4aff539ce4d97cfda Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/core Gerrit-Branch: master Gerrit-Owner: Aude <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
