b5cbb5ab3f
This allows us to remove many suppressions for phan false positives. Bug: T231636 Depends-On: I82a279e1f7b0fdefd3bb712e46c7d0665429d065 Change-Id: I5c251e9584a1ae9fb1577afcafb5001e0dcd41c7
130 lines
2.6 KiB
PHP
130 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* Abstract block restriction.
|
|
*
|
|
* 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\Restriction;
|
|
|
|
abstract class AbstractRestriction implements Restriction {
|
|
|
|
/**
|
|
* String constant identifying the type of restriction. Expected to be overriden in subclasses
|
|
* with a non-empty string value.
|
|
*/
|
|
const TYPE = '';
|
|
|
|
/**
|
|
* Numeric type identifier. Expected to be overriden in subclasses with a non-zero integer
|
|
* number. Must not exceed 127 to fit into a TINYINT database field.
|
|
*/
|
|
const TYPE_ID = 0;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $blockId;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $value;
|
|
|
|
/**
|
|
* Create Restriction.
|
|
*
|
|
* @since 1.33
|
|
* @param int $blockId
|
|
* @param int $value
|
|
*/
|
|
public function __construct( $blockId, $value ) {
|
|
$this->blockId = (int)$blockId;
|
|
$this->value = (int)$value;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public static function getType() {
|
|
return static::TYPE;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public static function getTypeId() {
|
|
return static::TYPE_ID;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getBlockId() {
|
|
return $this->blockId;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function setBlockId( $blockId ) {
|
|
$this->blockId = (int)$blockId;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getValue() {
|
|
return $this->value;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public static function newFromRow( \stdClass $row ) {
|
|
// @phan-suppress-next-line PhanTypeInstantiateAbstractStatic
|
|
return new static( $row->ir_ipb_id, $row->ir_value );
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function toRow() {
|
|
return [
|
|
'ir_ipb_id' => $this->getBlockId(),
|
|
'ir_type' => $this->getTypeId(),
|
|
'ir_value' => $this->getValue(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function equals( Restriction $other ) {
|
|
return $this->getHash() === $other->getHash();
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getHash() {
|
|
return $this->getType() . '-' . $this->getValue();
|
|
}
|
|
}
|