includes/context/ContextSource.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  * The simplest way of implementing IContextSource is to hold a RequestContext as a
  28  * member variable and provide accessors to it.
  29  */
  30 abstract class ContextSource implements IContextSource {
  31         /**
  32          * @var IContextSource
  33          */
  34         private $context;
  35
  36         /**
  37          * Get the RequestContext object
  38          * @since 1.18
  39          * @return RequestContext
  40          */
  41         public function getContext() {
  42                 if ( $this->context === null ) {
  43                         $class = get_class( $this );
  44                         wfDebug( __METHOD__ . " ($class): called and \$context is null. " .
  45                                 "Using RequestContext::getMain() for sanity\n" );
  46                         $this->context = RequestContext::getMain();
  47                 }
  48
  49                 return $this->context;
  50         }
  51
  52         /**
  53          * Set the IContextSource object
  54          *
  55          * @since 1.18
  56          * @param IContextSource $context
  57          */
  58         public function setContext( IContextSource $context ) {
  59                 $this->context = $context;
  60         }
  61
  62         /**
  63          * Get the WebRequest object
  64          *
  65          * @since 1.18
  66          * @return WebRequest
  67          */
  68         public function getRequest() {
  69                 return $this->getContext()->getRequest();
  70         }
  71
  72         /**
  73          * Get the Title object
  74          *
  75          * @since 1.18
  76          * @return Title
  77          */
  78         public function getTitle() {
  79                 return $this->getContext()->getTitle();
  80         }
  81
  82         /**
  83          * Check whether a WikiPage object can be get with getWikiPage().
  84          * Callers should expect that an exception is thrown from getWikiPage()
  85          * if this method returns false.
  86          *
  87          * @since 1.19
  88          * @return bool
  89          */
  90         public function canUseWikiPage() {
  91                 return $this->getContext()->canUseWikiPage();
  92         }
  93
  94         /**
  95          * Get the WikiPage object.
  96          * May throw an exception if there's no Title object set or the Title object
  97          * belongs to a special namespace that doesn't have WikiPage, so use first
  98          * canUseWikiPage() to check whether this method can be called safely.
  99          *
 100          * @since 1.19
 101          * @return WikiPage
 102          */
 103         public function getWikiPage() {
 104                 return $this->getContext()->getWikiPage();
 105         }
 106
 107         /**
 108          * Get the OutputPage object
 109          *
 110          * @since 1.18
 111          * @return OutputPage
 112          */
 113         public function getOutput() {
 114                 return $this->getContext()->getOutput();
 115         }
 116
 117         /**
 118          * Get the User object
 119          *
 120          * @since 1.18
 121          * @return User
 122          */
 123         public function getUser() {
 124                 return $this->getContext()->getUser();
 125         }
 126
 127         /**
 128          * Get the Language object
 129          *
 130          * @deprecated since 1.19 Use getLanguage instead
 131          * @return Language
 132          */
 133         public function getLang() {
 134                 wfDeprecated( __METHOD__, '1.19' );
 135
 136                 return $this->getLanguage();
 137         }
 138
 139         /**
 140          * Get the Language object
 141          *
 142          * @since 1.19
 143          * @return Language
 144          */
 145         public function getLanguage() {
 146                 return $this->getContext()->getLanguage();
 147         }
 148
 149         /**
 150          * Get the Skin object
 151          *
 152          * @since 1.18
 153          * @return Skin
 154          */
 155         public function getSkin() {
 156                 return $this->getContext()->getSkin();
 157         }
 158
 159         /**
 160          * Get a Message object with context set
 161          * Parameters are the same as wfMessage()
 162          *
 163          * @since 1.18
 164          * @return Message
 165          */
 166         public function msg( /* $args */ ) {
 167                 $args = func_get_args();
 168
 169                 return call_user_func_array( array( $this->getContext(), 'msg' ), $args );
 170         }
 171
 172         /**
 173          * Export the resolved user IP, HTTP headers, user ID, and session ID.
 174          * The result will be reasonably sized to allow for serialization.
 175          *
 176          * @return Array
 177          * @since 1.21
 178          */
 179         public function exportSession() {
 180                 return $this->getContext()->exportSession();
 181         }
 182 }