module MediaWiktory::Wikipedia::Modules::Categories

List all categories the pages belong to.

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

_categories(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/modules/categories.rb, line 72
def _categories(value)
  merge(clcategories: value.to_s, replace: false)
end
_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/categories.rb, line 85
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(cldir: value.to_s)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/categories.rb, line 30
def _prop(value)
  defined?(super) && super || ["sortkey", "timestamp", "hidden"].include?(value.to_s) && merge(clprop: value.to_s, replace: false)
end
_show(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/categories.rb, line 43
def _show(value)
  defined?(super) && super || ["hidden", "!hidden"].include?(value.to_s) && merge(clshow: value.to_s, replace: false)
end
categories(*values) click to toggle source

Only list these categories. Useful for checking whether a certain page is in a certain category.

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

# File lib/mediawiktory/wikipedia/modules/categories.rb, line 67
def categories(*values)
  values.inject(self) { |res, val| res._categories(val) }
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/categories.rb, line 59
def continue(value)
  merge(clcontinue: 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/categories.rb, line 80
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
limit(value) click to toggle source

How many categories to return.

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

# File lib/mediawiktory/wikipedia/modules/categories.rb, line 51
def limit(value)
  merge(cllimit: value.to_s)
end
prop(*values) click to toggle source

Which additional properties to get for each category:

@param values [Array<String>] Allowed values: “sortkey” (Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category), “timestamp” (Adds timestamp of when the category was added), “hidden” (Tags categories that are hidden with __HIDDENCAT__). @return [self]

# File lib/mediawiktory/wikipedia/modules/categories.rb, line 25
def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end
show(*values) click to toggle source

Which kind of categories to show.

@param values [Array<String>] Allowed values: “hidden”, “!hidden”. @return [self]

# File lib/mediawiktory/wikipedia/modules/categories.rb, line 38
def show(*values)
  values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" }
end