MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / externalstore / ExternalStoreMedium.php

diff --git a/includes/externalstore/ExternalStoreMedium.php b/includes/externalstore/ExternalStoreMedium.php
new file mode 100644 (file)
index 0000000..6cfa083
--- /dev/null
+++ b/includes/externalstore/ExternalStoreMedium.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * External storage in some particular medium.
+ *
+ * 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 ExternalStorage
+ */
+
+/**
+ * Accessable external objects in a particular storage medium
+ *
+ * @ingroup ExternalStorage
+ * @since 1.21
+ */
+abstract class ExternalStoreMedium {
+       /** @var array */
+       protected $params = [];
+
+       /**
+        * @param array $params Options
+        */
+       public function __construct( array $params = [] ) {
+               $this->params = $params;
+       }
+
+       /**
+        * Fetch data from given external store URL
+        *
+        * @param string $url An external store URL
+        * @return string|bool The text stored or false on error
+        * @throws MWException
+        */
+       abstract public function fetchFromURL( $url );
+
+       /**
+        * Fetch data from given external store URLs.
+        *
+        * @param array $urls A list of external store URLs
+        * @return array Map from the url to the text stored. Unfound data is not represented
+        */
+       public function batchFetchFromURLs( array $urls ) {
+               $retval = [];
+               foreach ( $urls as $url ) {
+                       $data = $this->fetchFromURL( $url );
+                       // Dont return when false to allow for simpler implementations.
+                       // errored urls are handled in ExternalStore::batchFetchFromURLs
+                       if ( $data !== false ) {
+                               $retval[$url] = $data;
+                       }
+               }
+
+               return $retval;
+       }
+
+       /**
+        * Insert a data item into a given location
+        *
+        * @param string $location The location name
+        * @param string $data The data item
+        * @return string|bool The URL of the stored data item, or false on error
+        * @throws MWException
+        */
+       abstract public function store( $location, $data );
+}