MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / user / UserArray.php

diff --git a/includes/user/UserArray.php b/includes/user/UserArray.php
new file mode 100644 (file)
index 0000000..ab6683b
--- /dev/null
+++ b/includes/user/UserArray.php
@@ -0,0 +1,89 @@
+<?php
+/**
+ * Class to walk into a list of User objects.
+ *
+ * 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
+ */
+
+use Wikimedia\Rdbms\ResultWrapper;
+
+abstract class UserArray implements Iterator {
+       /**
+        * @param ResultWrapper $res
+        * @return UserArrayFromResult
+        */
+       static function newFromResult( $res ) {
+               $userArray = null;
+               if ( !Hooks::run( 'UserArrayFromResult', [ &$userArray, $res ] ) ) {
+                       return null;
+               }
+               if ( $userArray === null ) {
+                       $userArray = self::newFromResult_internal( $res );
+               }
+               return $userArray;
+       }
+
+       /**
+        * @param array $ids
+        * @return UserArrayFromResult|ArrayIterator
+        */
+       static function newFromIDs( $ids ) {
+               $ids = array_map( 'intval', (array)$ids ); // paranoia
+               if ( !$ids ) {
+                       // Database::select() doesn't like empty arrays
+                       return new ArrayIterator( [] );
+               }
+               $dbr = wfGetDB( DB_REPLICA );
+               $res = $dbr->select(
+                       'user',
+                       User::selectFields(),
+                       [ 'user_id' => array_unique( $ids ) ],
+                       __METHOD__
+               );
+               return self::newFromResult( $res );
+       }
+
+       /**
+        * @since 1.25
+        * @param array $names
+        * @return UserArrayFromResult|ArrayIterator
+        */
+       static function newFromNames( $names ) {
+               $names = array_map( 'strval', (array)$names ); // paranoia
+               if ( !$names ) {
+                       // Database::select() doesn't like empty arrays
+                       return new ArrayIterator( [] );
+               }
+               $dbr = wfGetDB( DB_REPLICA );
+               $res = $dbr->select(
+                       'user',
+                       User::selectFields(),
+                       [ 'user_name' => array_unique( $names ) ],
+                       __METHOD__
+               );
+               return self::newFromResult( $res );
+       }
+
+       /**
+        * @param ResultWrapper $res
+        * @return UserArrayFromResult
+        */
+       protected static function newFromResult_internal( $res ) {
+               return new UserArrayFromResult( $res );
+       }
+}