Page MenuHomeWickedGov Phorge
Files F2751006

UserRegistrationLookup.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

UserRegistrationLookup.php
View Options

<?php
namespace MediaWiki\User\Registration;
use InvalidArgumentException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\MainConfigSchema;
use MediaWiki\User\UserIdentity;
use Wikimedia\ObjectFactory\ObjectFactory;
/**
* @since 1.41
*/
class UserRegistrationLookup {
/**
* @internal for use in ServiceWiring
* @var string[] Config names to require
*/
public const CONSTRUCTOR_OPTIONS = [
MainConfigNames::UserRegistrationProviders,
];
/** @var array ObjectFactory specs indexed by provider name */
private array $providersSpecs;
/** @var IUserRegistrationProvider[] Constructed registration providers indexed by name */
private array $providers = [];
private ObjectFactory $objectFactory;
public function __construct(
ServiceOptions $options,
ObjectFactory $objectFactory
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->providersSpecs = $options->get( MainConfigNames::UserRegistrationProviders );
$this->objectFactory = $objectFactory;
}
/**
* Is a registration provider registered?
*
* @see MainConfigSchema::UserRegistrationLookupProviders
* @param string $type
* @return bool
*/
public function isRegistered( string $type ): bool {
return array_key_exists( $type, $this->providersSpecs );
}
/**
* Construct a registration provider, if needed
*
* @param string $type
* @return IUserRegistrationProvider
*/
private function getProvider( string $type ): IUserRegistrationProvider {
if ( !$this->isRegistered( $type ) ) {
throw new InvalidArgumentException( 'Registration provider ' . $type . ' is not registered' );
}
if ( !array_key_exists( $type, $this->providers ) ) {
$this->providers[$type] = $this->objectFactory->createObject(
$this->providersSpecs[$type],
[ 'assertClass' => IUserRegistrationProvider::class ]
);
}
return $this->providers[$type];
}
/**
* @param UserIdentity $user User for which registration should be fetched.
* @param string $type Name of a registered registration provider
* @return string|null|false Registration timestamp (TS_MW), null if not available or false if it
* cannot be fetched (anonymous users, for example).
*/
public function getRegistration(
UserIdentity $user,
string $type = LocalUserRegistrationProvider::TYPE
) {
return $this->getProvider( $type )->fetchRegistration( $user );
}
/**
* Find the first registration timestamp for a given user
*
* Note this invokes _all_ registered providers.
*
* @param UserIdentity $user
* @return string|null Earliest registration timestamp (TS_MW), null if not available.
*/
public function getFirstRegistration( UserIdentity $user ): ?string {
$firstRegistrationTimestamp = null;
foreach ( $this->providersSpecs as $providerKey => $_ ) {
$registrationTimestamp = $this->getRegistration( $user, $providerKey );
if ( $registrationTimestamp === null || $registrationTimestamp === false ) {
// Provider was unable to return a registration timestamp for $providerKey, skip
// them.
continue;
}
if ( $firstRegistrationTimestamp === null ||
$registrationTimestamp < $firstRegistrationTimestamp
) {
$firstRegistrationTimestamp = $registrationTimestamp;
}
}
return $firstRegistrationTimestamp;
}
/**
* Get the first registration timestamp for a batch of users.
* This invokes all registered providers.
*
* @param iterable<UserIdentity> $users
* @return string[]|null[] Map of registration timestamps in MediaWiki format keyed by user ID.
* The timestamp may be `null` for users without a stored registration timestamp and for anonymous users.
*/
public function getFirstRegistrationBatch( iterable $users ): array {
$earliestTimestampsById = [];
foreach ( $users as $user ) {
$earliestTimestampsById[$user->getId()] = null;
}
foreach ( $this->providersSpecs as $providerKey => $_ ) {
$timestampsById = $this->getProvider( $providerKey )->fetchRegistrationBatch( $users );
foreach ( $timestampsById as $userId => $timestamp ) {
$curValue = $earliestTimestampsById[$userId];
if ( $timestamp !== null && ( $curValue === null || $timestamp < $curValue ) ) {
$earliestTimestampsById[$userId] = $timestamp;
}
}
}
return $earliestTimestampsById;
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 17:41 (18 h, 20 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
1e/9b/62740fd17dbeb84bf08a85bae5d0
Default Alt Text
UserRegistrationLookup.php (4 KB)

Event Timeline