includes/context/MutableContext.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  */
  20
  21 namespace MediaWiki\Context;
  22
  23 use MediaWiki\Config\Config;
  24 use MediaWiki\Language\Language;
  25 use MediaWiki\Output\OutputPage;
  26 use MediaWiki\Permissions\Authority;
  27 use MediaWiki\Request\WebRequest;
  28 use MediaWiki\Title\Title;
  29 use MediaWiki\User\User;
  30 use Skin;
  31 use WikiPage;
  32
  33 /**
  34  * Request-dependent objects containers.
  35  *
  36  * @since 1.26
  37  */
  38 interface MutableContext {
  39
  40         /**
  41          * @param Config $config
  42          */
  43         public function setConfig( Config $config );
  44
  45         /**
  46          * @param WebRequest $request
  47          */
  48         public function setRequest( WebRequest $request );
  49
  50         /**
  51          * @param Title $title
  52          */
  53         public function setTitle( Title $title );
  54
  55         /**
  56          * @param WikiPage $wikiPage
  57          */
  58         public function setWikiPage( WikiPage $wikiPage );
  59
  60         /**
  61          * @since 1.38
  62          * @param string $action
  63          */
  64         public function setActionName( string $action ): void;
  65
  66         /**
  67          * @param OutputPage $output
  68          */
  69         public function setOutput( OutputPage $output );
  70
  71         /**
  72          * @param User $user
  73          */
  74         public function setUser( User $user );
  75
  76         /**
  77          * @unstable
  78          * @param Authority $authority
  79          */
  80         public function setAuthority( Authority $authority );
  81
  82         /**
  83          * @param Language|string $language Language instance or language code
  84          */
  85         public function setLanguage( $language );
  86
  87         /**
  88          * @param Skin $skin
  89          */
  90         public function setSkin( Skin $skin );
  91
  92 }
  93
  94 /** @deprecated class alias since 1.42 */
  95 class_alias( MutableContext::class, 'MutableContext' );