wiki.techinc.nl/includes/block/Restriction/PageRestriction.php
Ammar Abdulhamid a68281552e Reduce SpecialBlock/Api logic duplication
Add PageRestriction::newFromTitle() to create from Title instance
or title string.

Change-Id: Id4c8117b916be05edc863bcd7a15c74fb28a833a
2021-01-22 05:49:50 +01:00

119 lines
2.6 KiB
PHP

<?php
/**
* A block restriction object of type 'Page'.
*
* 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;
class PageRestriction extends AbstractRestriction {
/**
* @inheritDoc
*/
public const TYPE = 'page';
/**
* @inheritDoc
*/
public const TYPE_ID = 1;
/**
* @var \Title|false|null
*/
protected $title;
/**
* @inheritDoc
*/
public function matches( \Title $title ) {
if ( !$this->getTitle() ) {
return false;
}
return $title->equals( $this->getTitle() );
}
/**
* @since 1.33
* @param \Title $title
* @return self
*/
public function setTitle( \Title $title ) {
$this->title = $title;
return $this;
}
/**
* @since 1.33
* @return \Title|false
*/
public function getTitle() {
if ( $this->title === null ) {
$this->title = \Title::newFromID( $this->value );
// If the title does not exist, set to false to prevent multiple database
// queries.
if ( $this->title === null ) {
$this->title = false;
}
}
return $this->title;
}
/**
* @inheritDoc
*/
public static function newFromRow( \stdClass $row ) {
/** @var self $restriction */
$restriction = parent::newFromRow( $row );
'@phan-var self $restriction';
// If the page_namespace and the page_title were provided, add the title to
// the restriction.
if ( isset( $row->page_namespace ) && isset( $row->page_title ) ) {
// Clone the row so it is not mutated.
$row = clone $row;
$row->page_id = $row->ir_value;
$title = \Title::newFromRow( $row );
$restriction->setTitle( $title );
}
return $restriction;
}
/**
* @internal
* @since 1.36
* @param string|\Title $title
* @return self
*/
public static function newFromTitle( $title ) {
if ( is_string( $title ) ) {
$title = \Title::newFromText( $title );
}
$restriction = new self( 0, $title->getArticleID() );
$restriction->setTitle( $title );
return $restriction;
}
}