1ee50f1a77
* Use a consistent single-line comment style. * Start each sentence with a capital letter. * Use imperative mood. * Put a space between the adjective and the noun in "hardblock" and "rangeblock". * Capitalise acronyms. * Break long lines. * Remove excessively obvious or off-topic comments. * Indent the non-initial lines of a multi-line @ command. * Don't try to apply @deprecated to a parameter. Doxygen and PHPStorm interpret this as method deprecation. Bug: T345683 Change-Id: I7df126f7a031dde241dd46f66e5e83722f9b383c
113 lines
2.3 KiB
PHP
113 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* Block restriction interface.
|
|
*
|
|
* 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;
|
|
|
|
use MediaWiki\Title\Title;
|
|
|
|
interface Restriction {
|
|
|
|
/**
|
|
* Get the ID of the block.
|
|
*
|
|
* @since 1.33
|
|
* @return int
|
|
*/
|
|
public function getBlockId();
|
|
|
|
/**
|
|
* Set the ID of the block.
|
|
*
|
|
* @since 1.33
|
|
* @param int $blockId
|
|
* @return self
|
|
*/
|
|
public function setBlockId( $blockId );
|
|
|
|
/**
|
|
* Get the value of the restriction.
|
|
*
|
|
* @since 1.33
|
|
* @return int
|
|
*/
|
|
public function getValue();
|
|
|
|
/**
|
|
* Get the type of restriction
|
|
*
|
|
* @since 1.33
|
|
* @return string
|
|
*/
|
|
public static function getType();
|
|
|
|
/**
|
|
* Get the ID of the type of restriction. This ID is used in the database.
|
|
*
|
|
* @since 1.33
|
|
* @return int
|
|
*/
|
|
public static function getTypeId();
|
|
|
|
/**
|
|
* Create a new Restriction from a database row.
|
|
*
|
|
* @since 1.33
|
|
* @param \stdClass $row
|
|
* @return static
|
|
*/
|
|
public static function newFromRow( \stdClass $row );
|
|
|
|
/**
|
|
* Convert a restriction object into a row array for insertion.
|
|
*
|
|
* @since 1.33
|
|
* @return array
|
|
*/
|
|
public function toRow();
|
|
|
|
/**
|
|
* Determine if a restriction matches a given title.
|
|
*
|
|
* @since 1.33
|
|
* @param Title $title
|
|
* @return bool
|
|
*/
|
|
public function matches( Title $title );
|
|
|
|
/**
|
|
* Determine if a restriction equals another restriction.
|
|
*
|
|
* @since 1.33
|
|
* @param Restriction $other
|
|
* @return bool
|
|
*/
|
|
public function equals( Restriction $other );
|
|
|
|
/**
|
|
* Create a unique hash of the block restriction based on the type and value.
|
|
*
|
|
* @since 1.33
|
|
* @return string
|
|
*/
|
|
public function getHash();
|
|
|
|
}
|