UserFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use IDBAccessObject;
use User;
 
class UserFactory implements IDBAccessObject {
 
    private $userNameUtils;
 
    public function __construct( UserNameUtils $userNameUtils ) {
        $this->userNameUtils = $userNameUtils;
    }
 
    public function newFromName(
        string $name,
        string $validate = UserNameUtils::RIGOR_VALID
    ) {
        return User::newFromName( $name, $validate );
    }
 
    public function newAnonymous( $ip = null ) : User {
        if ( $ip ) {
            $validIp = $this->userNameUtils->isIP( $ip );
            if ( $validIp ) {
                $user = $this->newFromName( $ip, UserNameUtils::RIGOR_NONE );
            } else {
                throw new \InvalidArgumentException( 'Invalid IP address' );
            }
        } else {
            $user = new User();
        }
        return $user;
    }
 
    public function newFromId( int $id ) : User {
        return User::newFromId( $id );
    }
 
    public function newFromActorId( int $actorId ) : User {
        return User::newFromActorId( $actorId );
    }
 
    public function newFromUserIdentity( UserIdentity $userIdentity ) : User {
        if ( $userIdentity instanceof User ) {
            return $userIdentity;
        }
 
        return $this->newFromAnyId(
            $userIdentity->getId() === 0 ? null : $userIdentity->getId(),
            $userIdentity->getName() === '' ? null : $userIdentity->getName(),
            $userIdentity->getActorId() === 0 ? null : $userIdentity->getActorId()
        );
    }
 
    public function newFromAnyId(
        ?int $userId,
        ?string $userName,
        ?int $actorId,
        $dbDomain = false
    ) : User {
        return User::newFromAnyId( $userId, $userName, $actorId, $dbDomain );
    }
 
    public function newFromConfirmationCode(
        string $confirmationCode,
        int $flags = self::READ_NORMAL
    ) {
        return User::newFromConfirmationCode( $confirmationCode, $flags );
    }
 
}