includes/context/IContextSource.php

   1 <?php
   2 /**
   3  * Request-dependant objects containers.
   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  * @since 1.18
  21  *
  22  * @author Happy-melon
  23  * @file
  24  */
  25
  26 /**
  27  * Interface for objects which can provide a context on request.
  28  */
  29 interface IContextSource {
  30
  31         /**
  32          * Get the WebRequest object
  33          *
  34          * @return WebRequest
  35          */
  36         public function getRequest();
  37
  38         /**
  39          * Get the Title object
  40          *
  41          * @return Title
  42          */
  43         public function getTitle();
  44
  45         /**
  46          * Check whether a WikiPage object can be get with getWikiPage().
  47          * Callers should expect that an exception is thrown from getWikiPage()
  48          * if this method returns false.
  49          *
  50          * @since 1.19
  51          * @return bool
  52          */
  53         public function canUseWikiPage();
  54
  55         /**
  56          * Get the WikiPage object.
  57          * May throw an exception if there's no Title object set or the Title object
  58          * belongs to a special namespace that doesn't have WikiPage, so use first
  59          * canUseWikiPage() to check whether this method can be called safely.
  60          *
  61          * @since 1.19
  62          * @return WikiPage
  63          */
  64         public function getWikiPage();
  65
  66         /**
  67          * Get the OutputPage object
  68          *
  69          * @return OutputPage object
  70          */
  71         public function getOutput();
  72
  73         /**
  74          * Get the User object
  75          *
  76          * @return User
  77          */
  78         public function getUser();
  79
  80         /**
  81          * Get the Language object
  82          *
  83          * @deprecated 1.19 Use getLanguage instead
  84          * @return Language
  85          */
  86         public function getLang();
  87
  88         /**
  89          * Get the Language object
  90          *
  91          * @return Language
  92          * @since 1.19
  93          */
  94         public function getLanguage();
  95
  96         /**
  97          * Get the Skin object
  98          *
  99          * @return Skin
 100          */
 101         public function getSkin();
 102
 103         /**
 104          * Get a Message object with context set
 105          *
 106          * @return Message object
 107          */
 108         public function msg();
 109 }
 110