Editing Module:Article history/doc (section)

=== ArticleHistory ===

An ArticleHistory object does the main work of the module. It fetches the different Row objects, renders the box, renders the error messages, and renders category links. ArticleHistory objects can use all methods from the [[#Message|Message]] mixin. They also have the following public properties:

* <code>args</code> - a table of the arguments passed to the module by the user.
* <code>currentTitle</code> - the [[mw:Extension:Scribunto/Lua reference manual|title object]] for the current page.
* <code>cfg</code> - the module config table. This is taken from the config module at [[Module:Article history/config]], but is structured slightly differently due to preprocessing by the main module. Any table with an "aliases" subtable has this table removed, and the aliases are added as keys that the table can be accessed from. Conceptually, the config table {{code|1={ foo = {"a value", aliases = {"bar", "baz"} } }|2=lua}} would become {{code|1={foo = {"a value"}, bar = {"a value"}, baz = {"a value"} }|2=lua}}. (Although "bar" and "baz" would actually be references to the "foo" table, rather than completely new tables.)
* <code>prefixArgs</code> - a table of the arguments passed to the module by the user, sorted by their prefix and then their number. Non-string keys and keys that don't contain a number are ignored. (This means that positional parameters are ignored, as they are numbers, not strings.) The parameter numbers are stored in the first positional parameter of the subtables, and any gaps are removed so that the tables can be iterated over with ipairs. For example, the arguments {{code|1={a1x = 'eggs', a1y = 'spam', a2x = 'chips', b1z = 'beans', b3x = 'bacon'}|2=lua}} would translate into the prefixArgs table {{code|1={a = { {1, x = 'eggs', y = 'spam'}, {2, x = 'chips'} }, b = { {1, z = 'beans'}, {3, x = 'bacon'} } }|2=lua}}.

ArticleHistory objects have the following public methods:

* <code>ArticleHistory:try(func, ...)</code> - calls the function <var>func</var> with the arguments passed, and returns the first value produced by it. If any errors are encountered, they are caught and added to the object's internal errors table for later rendering by ArticleHistory:getErrorMessages.
* <code>ArticleHistory:getActionObjects()</code> - returns an array containing the Action objects for any actions specified by the user.
* <code>ArticleHistory:getStatusIdForCode(code)</code> - for the status code <var>code</var>, returns the canonical status ID.
* <code>ArticleHistory:getStatusObj()</code> - gets the status object for the template. This returns nil if no current status can be found.
* <code>ArticleHistory:getStatusId()</code> - returns the status ID for the template. This returns nil if no current status can be found.
* <code>ArticleHistory:getNoticeObjects()</code> - returns an array containing the template's Notice objects.
* <code>ArticleHistory:getCollapsibleNoticeObjects()</code> - returns an array containing the template's CollapsibleNotice objects.
* <code>ArticleHistory:getAllObjects(addSelf)</code> - returns an array containing all Status/MultiStatus, Notice, Action and CollapsibleNotice objects. if <var>addSelf</var> is true, the ArticleHistory object is appended to the array as well.
* <code>ArticleHistory:getNoticeBarIcons()</code> - returns an array of icons to be displayed on the notice bar (at the top-left of the collapsible table).
* <code>ArticleHistory:getErrorMessages()</code> - returns an array containing all error and warning strings. Errors are typically raised with Message:raiseError and caught with ArticleHistory:try, and warnings are added to individual objects with Message:addWarning.
* <code>ArticleHistory:renderHtml()</code> - renders the HTML table comprising all the visible output of the template, including status, notices, actions, collapsible notices, error messages and warnings. The result is returned as a string.
* <code>ArticleHistory:renderCategories()</code> - renders all category links and returns them as a string.

Calling <code>tostring()</code> on an ArticleHistory object gives you the HTML table made with ArticleHistory:renderHtml concatenated with the category links made with ArticleHistory:renderCategories.