module MediaWiktory::Wikipedia::Modules::Allcategories

Enumerate all categories.

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/allcategories.rb, line 62
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(acdir: value.to_s)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 99
def _prop(value)
  defined?(super) && super || ["size", "hidden"].include?(value.to_s) && merge(acprop: 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/allcategories.rb, line 33
def continue(value)
  merge(accontinue: value.to_s)
end
dir(value) click to toggle source

Direction to sort in.

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

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 57
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
from(value) click to toggle source

The category to start enumerating from.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 25
def from(value)
  merge(acfrom: value.to_s)
end
limit(value) click to toggle source

How many categories to return.

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

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 86
def limit(value)
  merge(aclimit: value.to_s)
end
max(value) click to toggle source

Only return categories with at most this many members.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 78
def max(value)
  merge(acmax: value.to_s)
end
min(value) click to toggle source

Only return categories with at least this many members.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 70
def min(value)
  merge(acmin: value.to_s)
end
prefix(value) click to toggle source

Search for all category titles that begin with this value.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 49
def prefix(value)
  merge(acprefix: value.to_s)
end
prop(*values) click to toggle source

Which properties to get:

@param values [Array<String>] Allowed values: “size” (Adds number of pages in the category), “hidden” (Tags categories that are hidden with __HIDDENCAT__). @return [self]

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

The category to stop enumerating at.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/allcategories.rb, line 41
def to(value)
  merge(acto: value.to_s)
end