a656d03597
Rather than having to do DatabaseBlock calls directly, and then ManualLogEntry calls to facilitate logging, let's create a BlockUser service, capable of blocking users and logging, optionally with permission checking. This should make blocking users easier for developers, for instance, AbuseFilter or CheckUser can easily benefit from this commit. Bug: T189073 Change-Id: Ifdced735b694b85116cb0e43dadbfa8e4cdb8cab
53 lines
1.5 KiB
PHP
53 lines
1.5 KiB
PHP
<?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\Block;
|
|
|
|
use MediaWiki\User\UserIdentity;
|
|
use User;
|
|
|
|
/**
|
|
* @since 1.36
|
|
*/
|
|
interface BlockUserFactory {
|
|
/**
|
|
* Create BlockUser
|
|
*
|
|
* @param string|UserIdentity $target Target of the block
|
|
* @param User $performer Performer of the block
|
|
* @param string $expiry Expiry of the block (timestamp or 'infinity')
|
|
* @param string $reason Reason of the block
|
|
* @param array $blockOptions Block options
|
|
* @param array $blockRestrictions Block restrictions
|
|
* @param array|null $tags Tags that should be assigned to the log entry
|
|
*
|
|
* @return BlockUser
|
|
*/
|
|
public function newBlockUser(
|
|
$target,
|
|
User $performer,
|
|
string $expiry,
|
|
string $reason = '',
|
|
array $blockOptions = [],
|
|
array $blockRestrictions = [],
|
|
$tags = []
|
|
) : BlockUser;
|
|
}
|