モジュール:Yesno/doc

このモジュールはブール値ち、またはブール値ち風ふうの文字もじ列れつの入力にゅうりょくを処理しょりするための統一とういつしたインターフェースを提供ていきょうします。Luaではtrueとfalseといったブール値ちがありますが、ウィキテキストにおけるテンプレートでは"yes"、"no"など文字もじ列れつでしか処理しょりできません。このモジュールはこれらの文字もじ列れつを処理しょりして、Luaで使用しようするためのブール値ちに変換へんかんします。また、nilとfalseを区別くべつできるよう、nilの入力にゅうりょくはnilとして返かえします。このモジュールはブール値ち、数字すうじ、テーブル、関数かんすうの入力にゅうりょくも受うけ付つけており、ブール値ちとnilとして認識にんしきできなかった場合ばあいの返がえり値ちを指定していすることもできます。

書式しょしき

yesno(value, default)

valueは処理しょりされる入力にゅうりょくです。ブール値ちまたはブール値ち風ふうの文字もじ列れつが入力にゅうりょくされた場合ばあいはtrueまたはfalseを返かえし、nilが入力にゅうりょくされた場合ばあいはnilを返かえし、それ以外いがいの場合ばあいはdefaultを返かえします。

使用しよう法ほう

まず、モジュールをロードします。なお、このモジュールはほかのLuaモジュールでしか使用しようできません。テンプレートから使つかう場合ばあいは代かわりに{{yesno}}を使用しようしてください。

local yesno = require('Module:Yesno')

一部いちぶの入力にゅうりょく値ちは必かならずtrueを返かえし、一部いちぶは必かならずfalseを返かえします。nil値ねは必かならずnilを返かえします。

-- 必かならずtrueを返かえす
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

-- 必かならずfalseを返かえす
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- nil値ちは必かならずnil値ちを返かえす
yesno(nil)

文字もじ列れつはまず小文字こもじに変換へんかんしてから判別はんべつしています。

-- 必かならずtrueを返かえす
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- 必かならずfalseを返かえす
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')

上記じょうき以外いがいの入力にゅうりょくの場合ばあいに返かえすdefault値ちを指定していできます。指定していしなかった場合ばあいはnilを返かえします。

-- nilを返かえす
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

-- trueを返かえす
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)

-- "bar"を返かえす
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')

空文字くうもじ列れつでも同おなじ扱あつかいです。

yesno('')        -- nilを返かえす
yesno('', true)  -- trueを返かえす
yesno('', 'bar') -- "bar"を返かえす

ウィキテキストでは一般いっぱん的てきには空文字くうもじ列れつをfalseとして扱あつかうが、Luaではtrueとして扱あつかわれます。本ほんモジュールではLuaでの挙動きょどうを採用さいようしているため、空文字くうもじ列れつをfalseとして扱あつかう必要ひつようがある場合ばあいは別べつに処理しょりしてください。