3 #package to handle Boolean values in the parameters table
4 # Note: This is just a utility module; it should not be instantiated.
7 # Copyright 2003 Katipo Communications
9 # This file is part of Koha.
11 # Koha is free software; you can redistribute it and/or modify it under the
12 # terms of the GNU General Public License as published by the Free Software
13 # Foundation; either version 2 of the License, or (at your option) any later
16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along with
21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
22 # Suite 330, Boston, MA 02111-1307 USA
27 use vars
qw($VERSION @ISA @EXPORT @EXPORT_OK);
30 # set the version for version checking
34 &INVALID_BOOLEAN_STRING_EXCEPTION
44 C4::Boolean - Convenience functions to handle boolean values
45 in the parameter table
53 In the parameter table, there are various Boolean values that
54 variously require a 0/1, no/yes, false/true, or off/on values.
55 This module aims to provide scripts a means to interpret these
56 Boolean values in a consistent way which makes common sense.
64 sub INVALID_BOOLEAN_STRING_EXCEPTION
()
65 { 'The given value does not seem to be interpretable as a Boolean value' }
67 use vars
qw( %strings );
70 '0' => 0, '1' => 1, # C
72 'nil' => 0, 't' => 1, # LISP
73 'false' => 0, 'true' => 1, # Pascal
74 'off' => 0, 'on' => 1,
75 'no' => 0, 'yes' => 1,
81 if ( C4::Boolean::true_p(C4::Context->preference("insecure")) ) {
85 Tries to interpret the passed string as a Boolean value. Returns
86 the value if the string can be interpreted as such; otherwise an
94 if (!defined $x || ref($x) ne '') {
95 die INVALID_BOOLEAN_STRING_EXCEPTION;
99 if (defined $strings{$x}) {
102 die INVALID_BOOLEAN_STRING_EXCEPTION;
108 #---------------------------------
110 END { } # module clean-up code here (global destructor)
119 Koha Developement team <info@koha.org>