The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Value-Object-0.10
River stage zero No dependents
1 ++
/ Value::Object::ValidationUtils

NAME

Value::Object::ValidationUtils - Utility functions for validation of value objects

VERSION

This document describes Value::Object::ValidationUtils version 0.10

SYNOPSIS

    use Value::Object::ValidationUtils;

    print "Yes\n"
        if Value::Object::ValidationUtils::is_valid_domain_name( $foo );

DESCRIPTION

Some Value::Object-derived objects share code needed for validation. Rather than duplicating the knowledge of that information in multiple value objects, the knowledge and utilities are collected into this module.

INTERFACE

why_invalid_domain_name( $str )

Returns a three item list if the supplied $str is not a valid domain name as specified by RFCs 1123 and 2181. The first item is a short message describing the problem. The second item is empty and the third may contain a string with the part of the domain name that is invalid (depending on how it is invalid).

Returns an empty list if $str is a valid domain name.

is_valid_domain_name( $str )

Returns true if the supplied $str is a valid domain name as specified by RFCs 1123 and 2181. Otherwise, return false.

why_invalid_domain_label( $str )

Returns a three item list if the supplied $str is not a valid domain label as specified by RFCs 1123 and 2181. The first item is a short message describing the problem. The second item is empty and the third item is undef.

Returns an empty list if $str is a valid domain label.

is_valid_domain_label( $str )

Returns true if the supplied $str is a valid domain label as specified by RFCs 1123 and 2181. Otherwise, return false.

why_invalid_email_local_part( $str )

Returns a three item list if the supplied $str is not a valid email local part as specified by RFC 5322. The first item is a short message describing the problem. The second item is empty and the third item is undef.

Returns an empty list if $str is a valid email local part.

is_valid_email_local_part( $str )

Returns true if the supplied $str is a valid email address as specified by RFC 5322. Otherwise, return false.

why_invalid_common_email_local_part( $str )

Returns a three item list if the supplied $str is not a valid email local part mostly as specified by RFC 5322. The difference between the common version of the email local part and the standard is that the common version does not support the quoted form. This does seem to match the common usage of email addresses that I've seem.

The first item is a short message describing the problem. The second item is empty and the third item is undef.

Returns an empty list if $str is a valid common email local part.

is_valid_common_email_local_part( $str )

Returns true if the supplied $str is a valid email address as specified by common email address as defined by why_invalid_common_email_local_part. Otherwise, return false.

why_invalid_iso_8601_date( $str )

Returns a three item list if the supplied $str is not a valid date as specified by the W3C Date/Time format which conforms to ISO 8601 (YYYY-MM-DD).

The first item is a short message describing the problem. The second item is empty and the third item is data relating to the failure.

Returns an empty list if $str is a valid ISO 8601 date.

why_invalid_iso_8601_time( $str )

Returns a three item list if the supplied $str is not a valid time as specified by the W3C Date/Time format which conforms to ISO 8601 (HH:MM:SS(.SSS)?(Z|[+-]HH:MM)).

The first item is a short message describing the problem. The second item is empty and the third item is data relating to the failure.

Returns an empty list if $str is a valid ISO 8601 Time.

CONFIGURATION AND ENVIRONMENT

Value::Object::ValidationUtils requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-value-object@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

G. Wade Johnson gwadej@cpan.org

LICENCE AND COPYRIGHT

Copyright (c) 2014, G. Wade Johnson gwadej@cpan.org. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.