Merge "(bug 34933) Create "Check: [All] [None]" buttons with JavaScript"

[lhc/web/wiklou.git] / includes / filerepo / ForeignDBViaLBRepo.php

diff --git a/includes/filerepo/ForeignDBViaLBRepo.php b/includes/filerepo/ForeignDBViaLBRepo.php
index 8032575..bd76fce 100644 (file)
--- a/includes/filerepo/ForeignDBViaLBRepo.php
+++ b/includes/filerepo/ForeignDBViaLBRepo.php
@@ -1,7 +1,29 @@
 <?php
+/**
+ * A foreign repository with a MediaWiki database accessible via the configured LBFactory.
+ *
+ * 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
+ * @ingroup FileRepo
+ */
 
 /**
  * A foreign repository with a MediaWiki database accessible via the configured LBFactory
+ *
  * @ingroup FileRepo
  */
 class ForeignDBViaLBRepo extends LocalRepo {
@@ -9,6 +31,9 @@ class ForeignDBViaLBRepo extends LocalRepo {
        var $fileFactory = array( 'ForeignDBFile', 'newFromTitle' );
        var $fileFromRowFactory = array( 'ForeignDBFile', 'newFromRow' );
 
+       /**
+        * @param $info array|null
+        */
        function __construct( $info ) {
                parent::__construct( $info );
                $this->wiki = $info['wiki'];
@@ -16,13 +41,20 @@ class ForeignDBViaLBRepo extends LocalRepo {
                $this->hasSharedCache = $info['hasSharedCache'];
        }
 
+       /**
+        * @return DatabaseBase
+        */
        function getMasterDB() {
                return wfGetDB( DB_MASTER, array(), $this->wiki );
        }
 
+       /**
+        * @return DatabaseBase
+        */
        function getSlaveDB() {
                return wfGetDB( DB_SLAVE, array(), $this->wiki );
        }
+
        function hasSharedCache() {
                return $this->hasSharedCache;
        }
@@ -31,6 +63,7 @@ class ForeignDBViaLBRepo extends LocalRepo {
         * Get a key on the primary cache for this repository.
         * Returns false if the repository's cache is not accessible at this site. 
         * The parameters are the parts of the key, as for wfMemcKey().
+        * @return bool|string
         */
        function getSharedCacheKey( /*...*/ ) {
                if ( $this->hasSharedCache() ) {
@@ -42,13 +75,7 @@ class ForeignDBViaLBRepo extends LocalRepo {
                }
        }
 
-       function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
-               throw new MWException( get_class($this) . ': write operations are not supported' );
-       }
-       function publish( $srcPath, $dstRel, $archiveRel, $flags = 0 ) {
-               throw new MWException( get_class($this) . ': write operations are not supported' );
-       }
-       function deleteBatch( $fileMap ) {
-               throw new MWException( get_class($this) . ': write operations are not supported' );
+       protected function assertWritableRepo() {
+               throw new MWException( get_class( $this ) . ': write operations are not supported.' );
        }
 }