diff options
author | Luke Shumaker <lukeshu@sbcglobal.net> | 2016-05-01 15:30:02 -0400 |
---|---|---|
committer | Luke Shumaker <lukeshu@sbcglobal.net> | 2016-05-01 15:30:02 -0400 |
commit | 1de335ad3f395ca6861085393ba366a9e3fb4a0d (patch) | |
tree | f1fdd326034e05177596851be6a7127615d81498 /includes/api/ApiHelpParamValueMessage.php | |
parent | 9c75fa8ff6d4d38ef552c00fef5969fb154765e8 (diff) | |
parent | f6d65e533c62f6deb21342d4901ece24497b433e (diff) |
Merge commit 'f6d65'
# Conflicts:
# skins/ArchLinux/ArchLinux.php
Diffstat (limited to 'includes/api/ApiHelpParamValueMessage.php')
-rw-r--r-- | includes/api/ApiHelpParamValueMessage.php | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/includes/api/ApiHelpParamValueMessage.php b/includes/api/ApiHelpParamValueMessage.php new file mode 100644 index 00000000..7cf3d6ed --- /dev/null +++ b/includes/api/ApiHelpParamValueMessage.php @@ -0,0 +1,72 @@ +<?php +/** + * + * + * Created on Dec 22, 2014 + * + * Copyright © 2014 Brad Jorsch <bjorsch@wikimedia.org> + * + * 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 + */ + +/** + * Message subclass that prepends wikitext for API help. + * + * This exists so the apihelp-*-paramvalue-*-* messages don't all have to + * include markup wikitext while still keeping the + * 'APIGetParamDescriptionMessages' hook simple. + * + * @since 1.25 + */ +class ApiHelpParamValueMessage extends Message { + + protected $paramValue; + + /** + * @see Message::__construct + * + * @param string $paramValue Parameter value being documented + * @param string $text Message to use. + * @param array $params Parameters for the message. + * @throws InvalidArgumentException + */ + public function __construct( $paramValue, $text, $params = array() ) { + parent::__construct( $text, $params ); + $this->paramValue = $paramValue; + } + + /** + * Fetch the parameter value + * @return string + */ + public function getParamValue() { + return $this->paramValue; + } + + /** + * Fetch the message. + * @return string + */ + public function fetchMessage() { + if ( $this->message === null ) { + $this->message = ";{$this->paramValue}:" . parent::fetchMessage(); + } + return $this->message; + } + +} |