X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fsite%2FSiteListFileCache.php;h=e48a187a8d66137a6dd6c8be574289edc4a33d6d;hb=b780d900e3b36fb5b85bb58c61efaa2e32db984f;hp=c0ecab15499bb45d72ec287267e3562c78311bad;hpb=2511986f367bd4d8c56cf9ed3f8ef02c68a7b8d1;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/site/SiteListFileCache.php b/includes/site/SiteListFileCache.php
index c0ecab1549..e48a187a8d 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,12 +15,19 @@
  * 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 @@ class SiteListFileCache {
 	}
 
 	/**
+	 * @param string $globalId
+	 *
 	 * @since 1.25
+	 *
+	 * @return Site|null
 	 */
 	public function getSite( $globalId ) {
 		$sites = $this->getSites();
@@ -72,7 +82,7 @@ class SiteListFileCache {
 		$sites = new SiteList();
 
 		// @todo lazy initialize the site objects in the site list (e.g. only when needed to access)
-		foreach( $data['sites'] as $siteArray ) {
+		foreach ( $data['sites'] as $siteArray ) {
 			$sites[] = $this->newSiteFromArray( $siteArray );
 		}
 
@@ -116,7 +126,7 @@ class SiteListFileCache {
 		$site->setExtraData( $data['data'] );
 		$site->setExtraConfig( $data['config'] );
 
-		foreach( $data['identifiers'] as $identifier ) {
+		foreach ( $data['identifiers'] as $identifier ) {
 			$site->addLocalId( $identifier['type'], $identifier['key'] );
 		}