wikimedia/mediawiki-core

<?php
/**
 * 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
 */

namespace MediaWiki\Permissions;

use MediaWiki\User\UserIdentity;

/**
 * Represents the subject that rate limits are applied to.
 *
 * @unstable
 * @since 1.39
 */
class RateLimitSubject {

    /**
     * @var UserIdentity
     */
    private $user;

    /**
     * @var string|null
     */
    private $ip;

    /**
     * @var array
     */
    private $flags;

    /** @var string Flag indicating the user is exempt from rate limits */
    public const EXEMPT = 'exempt';

    /** @var string Flag indicating the user is a newbie */
    public const NEWBIE = 'newbie';

    /**
     * @internal
     *
     * @param UserIdentity $user
     * @param string|null $ip
     * @param array<string,bool> $flags
     */
    public function __construct( UserIdentity $user, ?string $ip, array $flags ) {
        $this->user = $user;
        $this->ip = $ip;
        $this->flags = $flags;
    }

    /**
     * @return UserIdentity
     */
    public function getUser(): UserIdentity {
        return $this->user;
    }

    /**
     * @return string|null
     */
    public function getIP(): ?string {
        return $this->ip;
    }

    /**
     * Checks whether the given flag applies.
     *
     * @param string $flag
     *
     * @return bool
     */
    public function is( string $flag ) {
        return !empty( $this->flags[$flag] );
    }

}