webmcp
annotate framework/env/format/boolean.lua @ 466:2751b6b81c23
Minor efficiency enhancement in <db_object>:try_save() method
| author | jbe |
|---|---|
| date | Mon Nov 07 19:32:51 2016 +0100 (2016-11-07) |
| parents | 9fdfb27f8e67 |
| children |
| rev | line source |
|---|---|
| jbe/bsw@0 | 1 --[[-- |
| jbe/bsw@0 | 2 text = -- human text representation of the boolean |
| jbe/bsw@0 | 3 format.boolean( |
| jbe/bsw@0 | 4 value, -- true, false or nil |
| jbe/bsw@0 | 5 { |
| jbe/bsw@0 | 6 true_as = true_text, -- text representing true |
| jbe/bsw@0 | 7 false_as = false_text, -- text representing false |
| jbe/bsw@0 | 8 nil_as = nil_text -- text representing nil |
| jbe/bsw@0 | 9 } |
| jbe/bsw@0 | 10 ) |
| jbe/bsw@0 | 11 |
| jbe/bsw@0 | 12 Returns a human readable text representation of a boolean value. Additional parameters should be given, unless you like the defaults for false and true, which are "0" and "1". |
| jbe/bsw@0 | 13 |
| jbe/bsw@0 | 14 --]]-- |
| jbe/bsw@0 | 15 |
| jbe/bsw@0 | 16 function format.boolean(value, options) |
| jbe/bsw@0 | 17 local options = options or {} |
| jbe/bsw@0 | 18 local true_text = options.true_as or "Yes" -- TODO: localization? |
| jbe/bsw@0 | 19 local false_text = options.false_as or "No" -- TODO: localization? |
| jbe/bsw@0 | 20 local nil_text = options.nil_as or "" |
| jbe/bsw@0 | 21 if value == nil then |
| jbe/bsw@0 | 22 return nil_text |
| jbe/bsw@0 | 23 elseif value == false then |
| jbe/bsw@0 | 24 return false_text |
| jbe/bsw@0 | 25 elseif value == true then |
| jbe/bsw@0 | 26 return true_text |
| jbe/bsw@0 | 27 else |
| jbe/bsw@0 | 28 error("Value passed to format.boolean(...) is neither a boolean nor nil.") |
| jbe/bsw@0 | 29 end |
| jbe/bsw@0 | 30 end |