Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

TitleDef: document return value as LinkTarget, not TitleValue

Browse source 
Change-Id: I894bc3d545b86fabb82fa32ba4f66626adcb540b
This commit is contained in:
Gergő Tisza 2020-11-06 17:07:14 -08:00
parent 84e9702349
commit 956ef28ffe
No known key found for this signature in database
GPG key ID: C34FEC97E6257F96
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
includes/ParamValidator/TypeDef/TitleDef.php
View file

@ -4,7 +4,6 @@ namespace MediaWiki\ParamValidator\TypeDef;
use MediaWiki\Linker\LinkTarget;
use TitleFactory;
use TitleValue;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\Callbacks;
use Wikimedia\ParamValidator\ParamValidator;
@ -30,7 +29,7 @@ class TitleDef extends TypeDef {
public const PARAM_MUST_EXIST = 'param-must-exist';
/**
* (bool) Whether to return a TitleValue object.
* (bool) Whether to return a LinkTarget.
*
* If false, the validated title is returned as a string (in getPrefixedText() format).
* Default is false.
@ -55,7 +54,7 @@ class TitleDef extends TypeDef {
/**
* @inheritDoc
* @return string|TitleValue Depending on the PARAM_RETURN_OBJECT setting.
* @return string|LinkTarget Depending on the PARAM_RETURN_OBJECT setting.
*/
public function validate( $name, $value, array $settings, array $options ) {
$mustExist = !empty( $settings[self::PARAM_MUST_EXIST] );