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         const TYPE = 'page';
  28         const TYPE_ID = 1;
  29
  30         /**
  31          * @var \Title
  32          */
  33         protected $title;
  34
  35         /**
  36          * {@inheritdoc}
  37          */
  38         public function matches( \Title $title ) {
  39                 return $title->equals( $this->getTitle() );
  40         }
  41
  42         /**
  43          * {@inheritdoc}
  44          */
  45         public function getType() {
  46                 return self::TYPE;
  47         }
  48
  49         /**
  50          * {@inheritdoc}
  51          */
  52         public function getTypeId() {
  53                 return self::TYPE_ID;
  54         }
  55
  56         /**
  57          * Set the title.
  58          *
  59          * @since 1.33
  60          * @param \Title $title
  61          * @return self
  62          */
  63         public function setTitle( \Title $title ) {
  64                 $this->title = $title;
  65
  66                 return $this;
  67         }
  68
  69         /**
  70          * Get Title.
  71          *
  72          * @since 1.33
  73          * @return \Title|null
  74          */
  75         public function getTitle() {
  76                 if ( !$this->title ) {
  77                         $this->title = \Title::newFromID( $this->value );
  78                 }
  79
  80                 return $this->title;
  81         }
  82
  83         /**
  84          * {@inheritdoc}
  85          */
  86         public static function newFromRow( \stdClass $row ) {
  87                 $restriction = parent::newFromRow( $row );
  88
  89                 // If the page_namespace and the page_title were provided, add the title to
  90                 // the restriction.
  91                 if ( isset( $row->page_namespace ) && isset( $row->page_title ) ) {
  92                         // Clone the row so it is not mutated.
  93                         $row = clone $row;
  94                         $row->page_id = $row->ir_value;
  95                         $title = \Title::newFromRow( $row );
  96                         $restriction->setTitle( $title );
  97                 }
  98
  99                 return $restriction;
 100         }
 101 }