diff options
Diffstat (limited to 'includes/parser/ParserCache.php')
| -rw-r--r-- | includes/parser/ParserCache.php | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/includes/parser/ParserCache.php b/includes/parser/ParserCache.php index 8b043290..6a4ef0c5 100644 --- a/includes/parser/ParserCache.php +++ b/includes/parser/ParserCache.php @@ -2,7 +2,23 @@ /** * Cache for outputs of the PHP parser * + * 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 + * * @file + * @ingroup Cache Parser */ /** @@ -77,6 +93,7 @@ class ParserCache { * * @param $article Article * @param $popts ParserOptions + * @return string */ function getETag( $article, $popts ) { return 'W/"' . $this->getParserOutputKey( $article, @@ -88,7 +105,7 @@ class ParserCache { * Retrieve the ParserOutput from ParserCache, even if it's outdated. * @param $article Article * @param $popts ParserOptions - * @return ParserOutput|false + * @return ParserOutput|bool False on failure */ public function getDirty( $article, $popts ) { $value = $this->get( $article, $popts, true ); @@ -102,8 +119,10 @@ class ParserCache { * * @todo Document parameter $useOutdated * - * @param $article Article - * @param $popts ParserOptions + * @param $article Article + * @param $popts ParserOptions + * @param $useOutdated Boolean (default true) + * @return bool|mixed|string */ public function getKey( $article, $popts, $useOutdated = true ) { global $wgCacheEpoch; @@ -139,11 +158,11 @@ class ParserCache { * Retrieve the ParserOutput from ParserCache. * false if not found or outdated. * - * @param $article Article - * @param $popts ParserOptions - * @param $useOutdated + * @param $article Article + * @param $popts ParserOptions + * @param $useOutdated Boolean (default false) * - * @return ParserOutput|false + * @return ParserOutput|bool False on failure */ public function get( $article, $popts, $useOutdated = false ) { global $wgCacheEpoch; |