includes/page/RedirectLookup.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @author Derick Alangi
  20  */
  21
  22 namespace MediaWiki\Page;
  23
  24 use MediaWiki\Linker\LinkTarget;
  25
  26 /**
  27  * Service for resolving a wiki page redirect.
  28  *
  29  * Default implementation is RedirectStore.
  30  *
  31  * @unstable
  32  * @since 1.38
  33  */
  34 interface RedirectLookup {
  35         /**
  36          * Get the redirect destination.
  37          *
  38          * @since 1.38
  39          * @param PageIdentity $page
  40          * @return LinkTarget|null Returns null if this page is not a redirect
  41          * @throws PageAssertionException If page does not represent an editable page
  42          */
  43         public function getRedirectTarget( PageIdentity $page ): ?LinkTarget;
  44 }