Module: MediaWiktory::Wikipedia::Modules::Phpfm

Defined in:
lib/mediawiktory/wikipedia/modules/phpfm.rb

Overview

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 Actions::Query and its submodules):

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.

Instance Method Summary collapse

Instance Method Details

#formatversion(value) ⇒ self

Output formatting:

Parameters:

  • 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).

Returns:

  • (self) 


32
33
34
 
# File 'lib/mediawiktory/wikipedia/modules/phpfm.rb', line 32

def formatversion(value)
  _formatversion(value) or fail ArgumentError, "Unknown value for formatversion: #{value}"
end

#wrappedhtml ⇒ self

Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.

Returns:

  • (self) 


24
25
26
 
# File 'lib/mediawiktory/wikipedia/modules/phpfm.rb', line 24

def wrappedhtml()
  merge(wrappedhtml: 'true')
end