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          * Get the OutputPage object
  47          *
  48          * @return OutputPage object
  49          */
  50         public function getOutput();
  51
  52         /**
  53          * Get the User object
  54          *
  55          * @return User
  56          */
  57         public function getUser();
  58
  59         /**
  60          * Get the Language object
  61          *
  62          * @deprecated 1.19 Use getLanguage instead
  63          * @return Language
  64          */
  65         public function getLang();
  66
  67         /**
  68          * Get the Language object
  69          *
  70          * @return Language
  71          * @since 1.19
  72          */
  73         public function getLanguage();
  74
  75         /**
  76          * Get the Skin object
  77          *
  78          * @return Skin
  79          */
  80         public function getSkin();
  81 }
  82