UserGroupMembership.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use InvalidArgumentException;
use MediaWiki\Context\IContextSource;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Title\Title;
 
class UserGroupMembership {
 
    private readonly ?string $expiry;
 
    private readonly bool $expired;
 
    public function __construct(
        private readonly int $userId = 0,
        private readonly ?string $group = null,
        ?string $expiry = null,
    ) {
        $this->expiry = $expiry ?: null;
        $this->expired = $expiry && wfTimestampNow() > $expiry;
    }
 
    public function getUserId() {
        return $this->userId;
    }
 
    public function getGroup() {
        return $this->group;
    }
 
    public function getExpiry() {
        return $this->expiry;
    }
 
    public function isExpired() {
        return $this->expired;
    }
 
    public static function getLink( $ugm, IContextSource $context, string $format, $userName = null ) {
        switch ( $format ) {
            case 'wiki':
                return self::getLinkWiki( $ugm, $context, $userName );
            case 'html':
                return self::getLinkHTML( $ugm, $context, $userName );
            default:
                throw new InvalidArgumentException( 'UserGroupMembership::getLink() $format parameter should be ' .
                    "'wiki' or 'html'" );
        }
    }
 
    public static function getLinkHTML( $ugm, IContextSource $context, $userName = null ): string {
        [
            'expiry' => $expiry,
            'linkTitle' => $linkTitle,
            'groupName' => $groupName
        ] = self::getLinkInfo( $ugm, $context, $userName );
 
        // link to the group description page, if it exists
        $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
        if ( $linkTitle ) {
            $groupLink = $linkRenderer->makeLink( $linkTitle, $groupName );
        } else {
            $groupLink = htmlspecialchars( $groupName );
        }
 
        if ( $expiry ) {
            [
                'expiryDT' => $expiryDT,
                'expiryD' => $expiryD,
                'expiryT' => $expiryT
            ] = self::getLinkExpiryParams( $context, $expiry );
            $groupLink = Message::rawParam( $groupLink );
            return $context->msg( 'group-membership-link-with-expiry' )
                ->params( $groupLink, $expiryDT, $expiryD, $expiryT )->escaped();
        }
        return $groupLink;
    }
 
    public static function getLinkWiki( $ugm, IContextSource $context, $userName = null ): string {
        [
            'expiry' => $expiry,
            'linkTitle' => $linkTitle,
            'groupName' => $groupName
        ] = self::getLinkInfo( $ugm, $context, $userName );
 
        // link to the group description page, if it exists
        if ( $linkTitle ) {
            $linkPage = $linkTitle->getFullText();
            $groupLink = "[[$linkPage|$groupName]]";
        } else {
            $groupLink = $groupName;
        }
 
        if ( $expiry ) {
            [
                'expiryDT' => $expiryDT,
                'expiryD' => $expiryD,
                'expiryT' => $expiryT
            ] = self::getLinkExpiryParams( $context, $expiry );
            return $context->msg( 'group-membership-link-with-expiry' )
                ->params( $groupLink, $expiryDT, $expiryD, $expiryT )->text();
        }
        return $groupLink;
    }
 
    private static function getLinkInfo( $ugm, $context, $userName = null ): array {
        if ( $ugm instanceof UserGroupMembership ) {
            $expiry = $ugm->getExpiry();
            $group = $ugm->getGroup();
        } else {
            $expiry = null;
            $group = $ugm;
        }
 
        $uiLanguage = $context->getLanguage();
        if ( $userName !== null ) {
            $groupName = $uiLanguage->getGroupMemberName( $group, $userName );
        } else {
            $groupName = $uiLanguage->getGroupName( $group );
        }
        $linkTitle = self::getGroupPage( $group );
        return [ 'expiry' => $expiry, 'linkTitle' => $linkTitle, 'groupName' => $groupName ];
    }
 
    private static function getLinkExpiryParams( IContextSource $context, string $expiry ): array {
        // format the expiry to a nice string
        $uiLanguage = $context->getLanguage();
        $uiUser = $context->getUser();
        $expiryDT = $uiLanguage->userTimeAndDate( $expiry, $uiUser );
        $expiryD = $uiLanguage->userDate( $expiry, $uiUser );
        $expiryT = $uiLanguage->userTime( $expiry, $uiUser );
        return [ 'expiryDT' => $expiryDT, 'expiryD' => $expiryD, 'expiryT' => $expiryT ];
    }
 
    public static function getGroupPage( $group ) {
        $msg = wfMessage( "grouppage-$group" )->inContentLanguage();
        if ( $msg->exists() ) {
            $title = Title::newFromText( $msg->text() );
            if ( $title ) {
                return $title;
            }
        }
        return false;
    }
 
    public function equals( UserGroupMembership $ugm ) {
        return (
            $ugm->getUserId() === $this->userId
            && $ugm->getGroup() === $this->group
        );
    }
 
}
 
class_alias( UserGroupMembership::class, 'UserGroupMembership' );