module MediaWiktory::Wikipedia::Modules::GLinks

Returns all links from the given pages. _Generator module: for fetching pages corresponding to request._

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

_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 72
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(gpldir: value.to_s)
end
_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 30
def _namespace(value)
  defined?(super) && super || ["-2", "-1", "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(gplnamespace: value.to_s, replace: false)
end
_titles(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 59
def _titles(value)
  merge(gpltitles: value.to_s, replace: false)
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 46
def continue(value)
  merge(gplcontinue: value.to_s)
end
dir(value) click to toggle source

The direction in which to list.

@param value [String] One of “ascending”, “descending”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 67
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
limit(value) click to toggle source

How many links to return.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 38
def limit(value)
  merge(gpllimit: value.to_s)
end
namespace(*values) click to toggle source

Show links in these namespaces only.

@param values [Array<String>] Allowed values: “-2”, “-1”, “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/g-links.rb, line 25
def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end
titles(*values) click to toggle source

Only list links to these titles. Useful for checking whether a certain page links to a certain title.

@param values [Array<String>] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-links.rb, line 54
def titles(*values)
  values.inject(self) { |res, val| res._titles(val) }
end