module MediaWiktory::Wikipedia::Modules::Linkshere
Find all pages that link to the given pages.
The “submodule” (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and its submodules):
“`ruby api.query # returns Actions::Query
.prop(:revisions) # adds prop=revisions to action URL, and includes Modules::Revisions into action .limit(10) # method of Modules::Revisions, adds rvlimit=10 to URL
“`
All submodule's parameters are documented as its public methods, see below.
Public Instance Methods
@private
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 43 def _namespace(value) defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(lhnamespace: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 30 def _prop(value) defined?(super) && super || ["pageid", "title", "redirect"].include?(value.to_s) && merge(lhprop: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 56 def _show(value) defined?(super) && super || ["redirect", "!redirect"].include?(value.to_s) && merge(lhshow: value.to_s, replace: false) end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 72 def continue(value) merge(lhcontinue: value.to_s) end
How many to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 64 def limit(value) merge(lhlimit: value.to_s) end
Only include pages in these namespaces.
@param values [Array<String>] Allowed values: “0”, “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “100”, “101”, “108”, “109”, “118”, “119”, “446”, “447”, “710”, “711”, “828”, “829”, “2300”, “2301”, “2302”, “2303”. @return [self]
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 38 def namespace(*values) values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" } end
Which properties to get:
@param values [Array<String>] Allowed values: “pageid” (Page ID of each page), “title” (Title of each page), “redirect” (Flag if the page is a redirect). @return [self]
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 25 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
Show only items that meet these criteria:
@param values [Array<String>] Allowed values: “redirect” (Only show redirects), “!redirect” (Only show non-redirects). @return [self]
# File lib/mediawiktory/wikipedia/modules/linkshere.rb, line 51 def show(*values) values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" } end