module MediaWiktory::Wikipedia::Modules::Phpfm
Output data in serialized PHP format (pretty-print in HTML).
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/phpfm.rb, line 37 def _formatversion(value) defined?(super) && super || ["1", "2", "latest"].include?(value.to_s) && merge(formatversion: value.to_s) end
Output formatting:
@param value [String] One of “1” (Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.)), “2” (Experimental modern format. Details may change!), “latest” (Use the latest format (currently 2), may change without warning). @return [self]
# File lib/mediawiktory/wikipedia/modules/phpfm.rb, line 32 def formatversion(value) _formatversion(value) or fail ArgumentError, "Unknown value for formatversion: #{value}" end
Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
@return [self]
# File lib/mediawiktory/wikipedia/modules/phpfm.rb, line 24 def wrappedhtml() merge(wrappedhtml: 'true') end