Block.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Block;
 
use MediaWiki\CommentStore\CommentStoreComment;
use MediaWiki\DAO\WikiAwareEntity;
use MediaWiki\User\UserIdentity;
 
interface Block extends WikiAwareEntity {
 
    # TYPE constants
    # Do not introduce negative constants without changing BlockUser command object.
    public const TYPE_USER = 1;
    public const TYPE_IP = 2;
    public const TYPE_RANGE = 3;
    public const TYPE_AUTO = 4;
 
    public const BLOCK_TYPES = [
        self::TYPE_USER => 'user',
        self::TYPE_IP => 'ip',
        self::TYPE_RANGE => 'range',
        self::TYPE_AUTO => 'autoblock',
    ];
 
    public function getId( $wikiId = self::LOCAL ): ?int;
 
    public function getIdentifier( $wikiId = self::LOCAL );
 
    public function getBlocker(): ?UserIdentity;
 
    public function getReasonComment(): CommentStoreComment;
 
    public function getTarget(): ?BlockTarget;
 
    public function getRedactedTarget(): ?BlockTarget;
 
    public function getTargetUserIdentity(): ?UserIdentity;
 
    public function getTargetName(): string;
 
    public function isBlocking( $target ): bool;
 
    public function getExpiry(): string;
 
    public function isIndefinite(): bool;
 
    public function getType(): ?int;
 
    public function getTimestamp(): string;
 
    public function isSitewide(): bool;
 
    public function isCreateAccountBlocked(): bool;
 
    public function isEmailBlocked(): bool;
 
    public function isHardblock(): bool;
 
    public function toArray(): array;
 
    public function appliesToUsertalk(): bool;
 
}