NAME
Brannigan::Validations - Built-in validation methods for Brannigan.
VERSION
version 0.4
DESCRIPTION
This module contains all built-in validation methods provided natively by the Brannigan input validation/parsing system.
METHODS
All these methods receive the value of a parameter, and other values that explicilty define the requirements. They return a true value if the parameter's value passed the test, or a false value otherwise.
required( $value, $boolean )
If $boolean is true, makes sure a required parameter was indeed provided, otherwise simply returns true.
Please note that if a parameter is not required and indeed isn't provided with the input parameters, any other validation methods defined on the parameter will not be checked.
forbidden( $value, $boolean )
If $boolean is true, makes sure a forbidden parameter was indeed NOT provided. Otherwise, a true value is returned.
length_between( $value, $min_length, $max_length )
Makes sure the value's length (stringwise) is inside the range of $min_length-$max_length, or, if the value is an array reference, makes sure it has between $min_length and $max_length items.
min_length( $value, $min_length )
Makes sure the value's length (stringwise) is at least $min_length, or, if the value is an array reference, makes sure it has at least $min_length items.
max_length( $value, $max_length )
Makes sure the value's length (stringwise) is no more than $max_length, or, if the value is an array reference, makes sure it has no more than $max_length items.
exact_length( $value, $length )
Makes sure the value's length (stringwise) is exactly $length, or, if the value is an array reference, makes sure it has exactly $exact_length items.
integer( $value, $boolean )
If boolean is true, makes sure the value is an integer.
value_between( $value, $min_value, $max_value )
Makes sure the value is between $min_value and $max_value.
min_value( $value, $min_value )
Makes sure the value is at least $min_value.
max_value( $value, $max )
Makes sure the value is no more than $max_value.
array( $value, $boolean )
If $boolean is true, makes sure the value is actually an array reference.
hash( $value, $boolean )
If $boolean is true, makes sure the value is actually a hash reference.
one_of( $value, @values )
Makes sure a parameter's value is one of the provided acceptable values.
SEE ALSO
AUTHOR
Ido Perlmuter, <ido at ido50 dot net>
BUGS
Please report any bugs or feature requests to bug-brannigan at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Brannigan. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Brannigan::ValidationsYou can also look for information at:
RT: CPAN's request tracker
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
LICENSE AND COPYRIGHT
Copyright 2010 Ido Perlmuter.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.