b3b70624c9
Expose info about user blocks from Authority. This allows calling code to provide more detailed information to the user about why they are denied some action on the wiki. Bug: T271494 Change-Id: Ia84e469888866d72752aad355292666c31e12bad
82 lines
2 KiB
PHP
82 lines
2 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\Permissions;
|
|
|
|
use MediaWiki\Block\Block;
|
|
use StatusValue;
|
|
|
|
/**
|
|
* A StatusValue for permission errors.
|
|
*
|
|
* @todo Add compat code for PermissionManager::getPermissionErrors
|
|
* and additional info about user blocks.
|
|
*
|
|
* @unstable
|
|
* @since 1.36
|
|
*/
|
|
class PermissionStatus extends StatusValue {
|
|
|
|
/** @var ?Block */
|
|
private $block = null;
|
|
|
|
/**
|
|
* Returns the user block that contributed to permissions being denied,
|
|
* if such a block was provided via setBlock().
|
|
*
|
|
* This is intended to be used to provide additional information to the user that
|
|
* allows them to determine the reason for them being denied an action.
|
|
*
|
|
* @since 1.37
|
|
*
|
|
* @return ?Block
|
|
*/
|
|
public function getBlock(): ?Block {
|
|
return $this->block;
|
|
}
|
|
|
|
/**
|
|
* @since 1.37
|
|
* @internal
|
|
* @param Block $block
|
|
*/
|
|
public function setBlock( Block $block ): void {
|
|
$this->block = $block;
|
|
}
|
|
|
|
/**
|
|
* @return static
|
|
*/
|
|
public static function newEmpty() {
|
|
return new static();
|
|
}
|
|
|
|
/**
|
|
* Returns this permission status in legacy error array format.
|
|
*
|
|
* @see PermissionManager::getPermissionErrors()
|
|
*
|
|
* @return array
|
|
*/
|
|
public function toLegacyErrorArray(): array {
|
|
return $this->getStatusArray();
|
|
}
|
|
|
|
}
|