ldoc

• Index

Contents

• Metamethods
• Methods

Classes

• Cache
• Root

Modules

• mw.templatedata

Class Root

Root holding an blessed access to TemplateData proxy.

Metamethods

Root:__index (key)

Lookup of missing class members.

Methods

Root:bless (tbl)	Bless an existing table into an instance.
Root:isValid ()	Validate the assumptions.
Root:hasOrderedParams ()	Has ordered params.
Root:hasSets ()	Has sets.
Root:hasMaps ()	Has maps.
Root:getOrderedNames ()	Get names in order.
Root:getAllNames ()	Get all names.
Root:isCompletelyOrdered ()	Is completely ordered.
Root:getNamesFromSets (...)	Get names from sets.
Root:getParams (...)	Get one or more specific params
Root:getUnsatisfied ()	Get unsatisfied params
Root:getValues (...)	Get one or more specific values
Root:satisfyFromFrame (frame, ...)	Satisfy from frame.

Metamethods

Root:__index (key)

Lookup of missing class members.

Parameters:

• key used for lookup of member

Returns:

any

Methods

Root:bless (tbl)

Bless an existing table into an instance.

Parameters:

• tbl table to be blessed

Returns:

self

Root:isValid ()

Validate the assumptions. The class makes some assumptions about the blessed reference.

Returns:

boolean

Root:hasOrderedParams ()

Has ordered params.

Returns:

boolean

Root:hasSets ()

Has sets.

Returns:

boolean

Root:hasMaps ()

Has maps.

Returns:

boolean

Root:getOrderedNames ()

Get names in order. Order names according to param order.

Returns:

list of names

Root:getAllNames ()

Get all names. All names, no particular order.

Returns:

list of names

Root:isCompletelyOrdered ()

Is completely ordered. Checks if the param order is complete given the params. All existing params must be ordered, but non-existing params does not matter.

Returns:

boolean

Root:getNamesFromSets (...)

Get names from sets. This will not maintain any particular order.

Parameters:

• ... of names

Returns:

list of names

Root:getParams (...)

Get one or more specific params

Parameters:

• ... varargs of names

Returns:

list of Param

Root:getUnsatisfied ()

Get unsatisfied params

Returns:

list of names

Root:getValues (...)

Get one or more specific values

Parameters:

• ... varargs of names

Returns:

list of values

Root:satisfyFromFrame (frame, ...)

Satisfy from frame. If necessary use the current frame.

Parameters:

• frame object for passing template arguments
• ... varagrs of names

Returns:

self