diff options
Diffstat (limited to 'includes/api/ApiQueryLinks.php')
| -rw-r--r-- | includes/api/ApiQueryLinks.php | 43 |
1 files changed, 12 insertions, 31 deletions
diff --git a/includes/api/ApiQueryLinks.php b/includes/api/ApiQueryLinks.php index 71329c4d..3bd37144 100644 --- a/includes/api/ApiQueryLinks.php +++ b/includes/api/ApiQueryLinks.php @@ -34,26 +34,20 @@ class ApiQueryLinks extends ApiQueryGeneratorBase { const LINKS = 'links'; const TEMPLATES = 'templates'; - private $table, $prefix, $description, $helpUrl; + private $table, $prefix, $helpUrl; public function __construct( ApiQuery $query, $moduleName ) { switch ( $moduleName ) { case self::LINKS: $this->table = 'pagelinks'; $this->prefix = 'pl'; - $this->description = 'link'; $this->titlesParam = 'titles'; - $this->titlesParamDescription = 'Only list links to these titles. Useful ' . - 'for checking whether a certain page links to a certain title.'; $this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#links_.2F_pl'; break; case self::TEMPLATES: $this->table = 'templatelinks'; $this->prefix = 'tl'; - $this->description = 'template'; $this->titlesParam = 'templates'; - $this->titlesParamDescription = 'Only list these templates. Useful ' . - 'for checking whether a certain page uses a certain template.'; $this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#templates_.2F_tl'; break; default: @@ -197,7 +191,9 @@ class ApiQueryLinks extends ApiQueryGeneratorBase { ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 ), - 'continue' => null, + 'continue' => array( + ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', + ), $this->titlesParam => array( ApiBase::PARAM_ISMULTI => true, ), @@ -211,32 +207,17 @@ class ApiQueryLinks extends ApiQueryGeneratorBase { ); } - public function getParamDescription() { - $desc = $this->description; - - return array( - 'namespace' => "Show {$desc}s in this namespace(s) only", - 'limit' => "How many {$desc}s to return", - 'continue' => 'When more results are available, use this to continue', - $this->titlesParam => $this->titlesParamDescription, - 'dir' => 'The direction in which to list', - ); - } - - public function getDescription() { - return "Returns all {$this->description}s from the given page(s)."; - } - - public function getExamples() { - $desc = $this->description; + protected function getExamplesMessages() { $name = $this->getModuleName(); + $path = $this->getModulePath(); return array( - "api.php?action=query&prop={$name}&titles=Main%20Page" => "Get {$desc}s from the [[Main Page]]", - "api.php?action=query&generator={$name}&titles=Main%20Page&prop=info" - => "Get information about the {$desc} pages in the [[Main Page]]", - "api.php?action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10" - => "Get {$desc}s from the Main Page in the User and Template namespaces", + "action=query&prop={$name}&titles=Main%20Page" + => "apihelp-{$path}-example-simple", + "action=query&generator={$name}&titles=Main%20Page&prop=info" + => "apihelp-{$path}-example-generator", + "action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10" + => "apihelp-{$path}-example-namespaces", ); } |