UserInfo.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Session;
 
use InvalidArgumentException;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\User;
use MediaWiki\User\UserRigorOptions;
use Stringable;
 
final class UserInfo implements Stringable {
    private $verified = false;
 
    private $user = null;
 
    private function __construct( ?User $user, $verified ) {
        $userNameUtils = MediaWikiServices::getInstance()->getUserNameUtils();
        if ( $user && $user->isAnon() && !$userNameUtils->isUsable( $user->getName() ) ) {
            $this->verified = true;
            $this->user = null;
        } else {
            $this->verified = $verified;
            $this->user = $user;
        }
    }
 
    public static function newAnonymous() {
        return new self( null, true );
    }
 
    public static function newFromId( $id, $verified = false ) {
        $user = MediaWikiServices::getInstance()->getUserFactory()->newFromId( (int)$id );
 
        // Ensure the ID actually exists
        $user->load();
        if ( $user->isAnon() ) {
            throw new InvalidArgumentException( 'Invalid ID' );
        }
 
        return new self( $user, $verified );
    }
 
    public static function newFromName( $name, $verified = false ) {
        $user = MediaWikiServices::getInstance()->getUserFactory()->newFromName(
            (string)$name,
            UserRigorOptions::RIGOR_USABLE
        );
        if ( !$user ) {
            throw new InvalidArgumentException( 'Invalid user name' );
        }
        return new self( $user, $verified );
    }
 
    public static function newFromUser( User $user, $verified = false ) {
        return new self( $user, $verified );
    }
 
    public function isAnon() {
        return $this->user === null;
    }
 
    public function isVerified() {
        return $this->verified;
    }
 
    public function getId() {
        return $this->user === null ? 0 : $this->user->getId();
    }
 
    public function getName() {
        return $this->user === null ? null : $this->user->getName();
    }
 
    public function getToken() {
        return $this->user === null || $this->user->getId() === 0 ? '' : $this->user->getToken( false );
    }
 
    public function getUser() {
        return $this->user ?? MediaWikiServices::getInstance()->getUserFactory()->newAnonymous();
    }
 
    public function verified() {
        return $this->verified ? $this : new self( $this->user, true );
    }
 
    public function __toString() {
        if ( $this->user === null ) {
            return '<anon>';
        }
        return '<' .
            ( $this->verified ? '+' : '-' ) . ':' .
            $this->getId() . ':' . $this->getName() .
            '>';
    }
 
}