NAME
Form::Factory::Control::Role::BooleanValue - boolean valued controls
VERSION
version 0.022
DESCRIPTION
Controls that implement this role have a boolean value. This say much about how that is actually implemented, just that is has a "true_value" a "false_value" and then a flag stating whether the true value or false value is currently selected.
ATTRIBUTES
true_value
The string value the control should have when the control "is_true".
false_value
The string value the control should have when the control is not "is_true".
METHODS
is_currently_true
Returns a true value when the current_value
is set to "true_value" or a false value when the current_value
is set to "false_value".
This method returns undef
if it is neither true nor false.
If passed a value, e.g.:
$self->is_currently_true(1);
This will set the current_value
. If a true value is given, the value
will be set to "true_value". Otherwise, it will cause the current_value
to take on the contents of "false_value".
is_true
Returns a true value when the value
is set to "true_value" or a false value when the value
is set to "false_value".
This method returns undef
if it is neither true nor false.
Unlikely "is_currently_true", this may not be used as a setter.
current_value
We need to handle current value special.
has_current_value
If the value is true or false, it has a current value. Otherwise, it does not.
AUTHOR
Andrew Sterling Hanenkamp <hanenkamp@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Qubling Software LLC.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.