Module:If any equal

Module documentation[view] [edit] [history] [purge]

This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This Lua module is used on approximately 243,000 pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Main

This main function of this module checks all positional parameters to see if any of them is equal to the parameter |value=. If so, it will output "yes", otherwise "no".

If the plural |values= is used, then one or more alternative values may be specified.

Examples

{{#invoke:If any equal|main|a|b|c|d|value=c}} gives Script error: The function "main" does not exist.
{{#invoke:If any equal|main|a|b|c|d|value=r}} gives Script error: The function "main" does not exist.
{{#invoke:If any equal|main|a|b|c|d|value=}} gives Script error: The function "main" does not exist.
{{#invoke:If any equal|main|a|b|c|d|values=r, b}} gives Script error: The function "main" does not exist.

IfAnyEqual

The IfAnyEqual function works in a similar way, but instead takes the names of the parameters and checks these arguments of the parent frame.

Example

For example, if you have the following code on {{Template}}

{{#invoke:If any equal|IfAnyEqual|param1|param2|values=a, b, c}}

Then calling {{Template}} will give the following results:

{{Template|param1=b|param2=f}} gives "yes"
{{Template|param1=z|param2=k}} gives "no"
{{Template|param2=a}} gives "yes"

Using a prefix

If a prefix is specified with |prefix= then the module will check any parameter that consists of that prefix and possibly a number afterwards.

Example

For example, if you have the following code on {{Template}}

{{#invoke:If any equal|IfAnyEqual|prefix=param|values=a, b, c}}

Then calling {{Template}} will give the following results:

{{Template|param=b|param2=f}} gives "yes"
{{Template|param1=z|param3=k}} gives "no"
{{Template|param12=a}} gives "yes"

The above documentation is transcluded from Module:If any equal/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

require('strict')
local p = {}

p.if_any = function(frame)
	local match = false
	for name, value in pairs(args) do
		if name:match('^%d+$') and value==frame.args.value then
			match = true
			break
		end
	end
	return match and 'yes' or 'no'
end

return p