MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / libs / ReplacementArray.php

diff --git a/includes/libs/ReplacementArray.php b/includes/libs/ReplacementArray.php
new file mode 100644 (file)
index 0000000..4512a4b
--- /dev/null
+++ b/includes/libs/ReplacementArray.php
@@ -0,0 +1,104 @@
+<?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
+ * 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
+ */
+
+/**
+ * Wrapper around strtr() that holds replacements
+ */
+class ReplacementArray {
+       private $data = false;
+
+       /**
+        * Create an object with the specified replacement array
+        * The array should have the same form as the replacement array for strtr()
+        * @param array $data
+        */
+       public function __construct( $data = [] ) {
+               $this->data = $data;
+       }
+
+       /**
+        * @return array
+        */
+       public function __sleep() {
+               return [ 'data' ];
+       }
+
+       /**
+        * Set the whole replacement array at once
+        * @param array $data
+        */
+       public function setArray( $data ) {
+               $this->data = $data;
+       }
+
+       /**
+        * @return array|bool
+        */
+       public function getArray() {
+               return $this->data;
+       }
+
+       /**
+        * Set an element of the replacement array
+        * @param string $from
+        * @param string $to
+        */
+       public function setPair( $from, $to ) {
+               $this->data[$from] = $to;
+       }
+
+       /**
+        * @param array $data
+        */
+       public function mergeArray( $data ) {
+               $this->data = $data + $this->data;
+       }
+
+       /**
+        * @param ReplacementArray $other
+        */
+       public function merge( ReplacementArray $other ) {
+               $this->data = $other->data + $this->data;
+       }
+
+       /**
+        * @param string $from
+        */
+       public function removePair( $from ) {
+               unset( $this->data[$from] );
+       }
+
+       /**
+        * @param array $data
+        */
+       public function removeArray( $data ) {
+               foreach ( $data as $from => $to ) {
+                       $this->removePair( $from );
+               }
+       }
+
+       /**
+        * @param string $subject
+        * @return string
+        */
+       public function replace( $subject ) {
+               return strtr( $subject, $this->data );
+       }
+}