diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2012-05-03 13:01:35 +0200 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2012-05-03 13:01:35 +0200 |
commit | d9022f63880ce039446fba8364f68e656b7bf4cb (patch) | |
tree | 16b40fbf17bf7c9ee6f4ead25b16dd192378050a /includes/context/IContextSource.php | |
parent | 27cf83d177256813e2e802241085fce5dd0f3fb9 (diff) |
Update to MediaWiki 1.19.0
Diffstat (limited to 'includes/context/IContextSource.php')
-rw-r--r-- | includes/context/IContextSource.php | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/includes/context/IContextSource.php b/includes/context/IContextSource.php new file mode 100644 index 00000000..476035b5 --- /dev/null +++ b/includes/context/IContextSource.php @@ -0,0 +1,110 @@ +<?php +/** + * Request-dependant objects containers. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @since 1.18 + * + * @author Happy-melon + * @file + */ + +/** + * Interface for objects which can provide a context on request. + */ +interface IContextSource { + + /** + * Get the WebRequest object + * + * @return WebRequest + */ + public function getRequest(); + + /** + * Get the Title object + * + * @return Title + */ + public function getTitle(); + + /** + * Check whether a WikiPage object can be get with getWikiPage(). + * Callers should expect that an exception is thrown from getWikiPage() + * if this method returns false. + * + * @since 1.19 + * @return bool + */ + public function canUseWikiPage(); + + /** + * Get the WikiPage object. + * May throw an exception if there's no Title object set or the Title object + * belongs to a special namespace that doesn't have WikiPage, so use first + * canUseWikiPage() to check whether this method can be called safely. + * + * @since 1.19 + * @return WikiPage + */ + public function getWikiPage(); + + /** + * Get the OutputPage object + * + * @return OutputPage object + */ + public function getOutput(); + + /** + * Get the User object + * + * @return User + */ + public function getUser(); + + /** + * Get the Language object + * + * @deprecated 1.19 Use getLanguage instead + * @return Language + */ + public function getLang(); + + /** + * Get the Language object + * + * @return Language + * @since 1.19 + */ + public function getLanguage(); + + /** + * Get the Skin object + * + * @return Skin + */ + public function getSkin(); + + /** + * Get a Message object with context set + * + * @return Message object + */ + public function msg(); +} + |