includes/block/Restriction/PageRestriction.php

   1 <?php
   2 /**
   3  * A Block restriction object of type 'Page'.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 namespace MediaWiki\Block\Restriction;
  24
  25 class PageRestriction extends AbstractRestriction {
  26
  27         /**
  28          * {@inheritdoc}
  29          */
  30         const TYPE = 'page';
  31
  32         /**
  33          * {@inheritdoc}
  34          */
  35         const TYPE_ID = 1;
  36
  37         /**
  38          * @var \Title
  39          */
  40         protected $title;
  41
  42         /**
  43          * {@inheritdoc}
  44          */
  45         public function matches( \Title $title ) {
  46                 return $title->equals( $this->getTitle() );
  47         }
  48
  49         /**
  50          * Set the title.
  51          *
  52          * @since 1.33
  53          * @param \Title $title
  54          * @return self
  55          */
  56         public function setTitle( \Title $title ) {
  57                 $this->title = $title;
  58
  59                 return $this;
  60         }
  61
  62         /**
  63          * Get Title.
  64          *
  65          * @since 1.33
  66          * @return \Title|null
  67          */
  68         public function getTitle() {
  69                 if ( !$this->title ) {
  70                         $this->title = \Title::newFromID( $this->value );
  71                 }
  72
  73                 return $this->title;
  74         }
  75
  76         /**
  77          * {@inheritdoc}
  78          */
  79         public static function newFromRow( \stdClass $row ) {
  80                 $restriction = parent::newFromRow( $row );
  81
  82                 // If the page_namespace and the page_title were provided, add the title to
  83                 // the restriction.
  84                 if ( isset( $row->page_namespace ) && isset( $row->page_title ) ) {
  85                         // Clone the row so it is not mutated.
  86                         $row = clone $row;
  87                         $row->page_id = $row->ir_value;
  88                         $title = \Title::newFromRow( $row );
  89                         $restriction->setTitle( $title );
  90                 }
  91
  92                 return $restriction;
  93         }
  94 }