Merge "(bug 27395) Write PHPUnit test suite for CSSJanus"
[lhc/web/wiklou.git] / includes / LocalisationCache.php
index 3b1f45c..9ce26d0 100644 (file)
@@ -1,4 +1,24 @@
 <?php
+/**
+ * Cache of the contents of localisation files.
+ *
+ * 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
+ */
 
 define( 'MW_LC_VERSION', 2 );
 
@@ -343,6 +363,7 @@ class LocalisationCache {
 
        /**
         * Returns true if the cache identified by $code is missing or expired.
+        * @return bool
         */
        public function isExpired( $code ) {
                if ( $this->forceRecache && !isset( $this->recachedLangs[$code] ) ) {
@@ -793,8 +814,8 @@ class LocalisationCache {
 interface LCStore {
        /**
         * Get a value.
-        * @param $code Language code
-        * @param $key Cache key
+        * @param $code string Language code
+        * @param $key string Cache key
         */
        function get( $code, $key );
 
@@ -908,12 +929,12 @@ class LCStore_DB implements LCStore {
 
                $this->dbw = wfGetDB( DB_MASTER );
                try {
-                       $this->dbw->begin();
+                       $this->dbw->begin( __METHOD__ );
                        $this->dbw->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__ );
                } catch ( DBQueryError $e ) {
                        if ( $this->dbw->wasReadOnlyError() ) {
                                $this->readOnly = true;
-                               $this->dbw->rollback();
+                               $this->dbw->rollback( __METHOD__ );
                                $this->dbw->ignoreErrors( false );
                                return;
                        } else {
@@ -934,7 +955,7 @@ class LCStore_DB implements LCStore {
                        $this->dbw->insert( 'l10n_cache', $this->batch, __METHOD__ );
                }
 
-               $this->dbw->commit();
+               $this->dbw->commit( __METHOD__ );
                $this->currentLang = null;
                $this->dbw = null;
                $this->batch = array();
@@ -1164,4 +1185,4 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
                        $this->unload( $code );
                }
        }
-}
\ No newline at end of file
+}