wiki.techinc.nl/includes/block/Restriction/PageRestriction.php
Thiemo Kreuz 30b05e1072 Replace lowercase {@inheritdoc} with @inheritDoc
According to the coding standards we even enforce with a custom PHPCS sniff.
It currently does not pick these mistakes up because of the curly brackets.
I'm not sure if this is worth an update of the PHPCS sniff. I wanted to
suggest this fix anyway.

Change-Id: I9041ea7a00baf7f55e0ff0e56879a89fb74bb479
2019-03-01 17:25:02 +00:00

104 lines
2.3 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
*/
const TYPE = 'page';
/**
* @inheritDoc
*/
const TYPE_ID = 1;
/**
* @var \Title|bool
*/
protected $title;
/**
* @inheritDoc
*/
public function matches( \Title $title ) {
if ( !$this->getTitle() ) {
return false;
}
return $title->equals( $this->getTitle() );
}
/**
* Set the title.
*
* @since 1.33
* @param \Title $title
* @return self
*/
public function setTitle( \Title $title ) {
$this->title = $title;
return $this;
}
/**
* Get Title.
*
* @since 1.33
* @return \Title|null
*/
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 ?? null;
}
/**
* @inheritDoc
*/
public static function newFromRow( \stdClass $row ) {
$restriction = parent::newFromRow( $row );
// 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;
}
}