wiki.techinc.nl/includes/user/UserArray.php
Brad Jorsch d032bb52cd Add a central ID lookup service
Anything that wants to be "central" right now has to depend on
CentralAuth, and then either can't work without CentralAuth or has to
branch all over the place based on whether CentralAuth is present. Most
of the time all it really needs is a mapping from local users to central
user IDs and back or the ability to query whether the local user is
attached on some other wiki, so let's make an interface for that in
core.

See I52aa0460 for an example implementation (CentralAuth), and Ibd192e29
for an example use (OAuth).

Bug: T111302
Change-Id: I49568358ec35fdfd0b9e53e441adabded5c7b80f
2015-12-02 14:50:36 -07:00

87 lines
2.3 KiB
PHP

<?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
*/
abstract class UserArray implements Iterator {
/**
* @param ResultWrapper $res
* @return UserArrayFromResult
*/
static function newFromResult( $res ) {
$userArray = null;
if ( !Hooks::run( 'UserArrayFromResult', array( &$userArray, $res ) ) ) {
return null;
}
if ( $userArray === null ) {
$userArray = self::newFromResult_internal( $res );
}
return $userArray;
}
/**
* @param array $ids
* @return UserArrayFromResult
*/
static function newFromIDs( $ids ) {
$ids = array_map( 'intval', (array)$ids ); // paranoia
if ( !$ids ) {
// Database::select() doesn't like empty arrays
return new ArrayIterator( array() );
}
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select(
'user',
User::selectFields(),
array( 'user_id' => array_unique( $ids ) ),
__METHOD__
);
return self::newFromResult( $res );
}
/**
* @since 1.25
* @param array $names
* @return UserArrayFromResult
*/
static function newFromNames( $names ) {
$names = array_map( 'strval', (array)$names ); // paranoia
if ( !$names ) {
// Database::select() doesn't like empty arrays
return new ArrayIterator( array() );
}
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select(
'user',
User::selectFields(),
array( '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 );
}
}