[Summary view] [Print] [Text view]

   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       * Get the WebRequest object
  32       *
  33       * @return WebRequest
  34       */
  35  	public function getRequest();
  36  
  37      /**
  38       * Get the Title object
  39       *
  40       * @return Title|null
  41       */
  42  	public function getTitle();
  43  
  44      /**
  45       * Check whether a WikiPage object can be get with getWikiPage().
  46       * Callers should expect that an exception is thrown from getWikiPage()
  47       * if this method returns false.
  48       *
  49       * @since 1.19
  50       * @return bool
  51       */
  52  	public function canUseWikiPage();
  53  
  54      /**
  55       * Get the WikiPage object.
  56       * May throw an exception if there's no Title object set or the Title object
  57       * belongs to a special namespace that doesn't have WikiPage, so use first
  58       * canUseWikiPage() to check whether this method can be called safely.
  59       *
  60       * @since 1.19
  61       * @return WikiPage
  62       */
  63  	public function getWikiPage();
  64  
  65      /**
  66       * Get the OutputPage object
  67       *
  68       * @return OutputPage
  69       */
  70  	public function getOutput();
  71  
  72      /**
  73       * Get the User object
  74       *
  75       * @return User
  76       */
  77  	public function getUser();
  78  
  79      /**
  80       * Get the Language object
  81       *
  82       * @return Language
  83       * @since 1.19
  84       */
  85  	public function getLanguage();
  86  
  87      /**
  88       * Get the Skin object
  89       *
  90       * @return Skin
  91       */
  92  	public function getSkin();
  93  
  94      /**
  95       * Get the site configuration
  96       *
  97       * @since 1.23
  98       * @return Config
  99       */
 100  	public function getConfig();
 101  
 102      /**
 103       * Get a Message object with context set
 104       *
 105       * @return Message
 106       */
 107  	public function msg();
 108  
 109      /**
 110       * Export the resolved user IP, HTTP headers, user ID, and session ID.
 111       * The result will be reasonably sized to allow for serialization.
 112       *
 113       * @return array
 114       * @since 1.21
 115       */
 116  	public function exportSession();
 117  }