NAME

Value::Object::Domain - Value object class representing Internet domain names

VERSION

This document describes Value::Object::Domain version 0.06

SYNOPSIS

    use Value::Object::Domain;

    my $mcpan = Value::Object::Domain->new( 'metacpan.org' );
    my $goog  = Value::Object::Domain->new( 'google.com' );

    my $domain = Value::Object::Domain->new( $unsafe_domain_name );
    # We'll only get here if the $unsafe_domain_name was a legal domain name

    print "'", $domain->value, "' is a valid domain name.\n";

DESCRIPTION

A Value::Object::Domain value object represents an Internet domain name as defined in RFCs 1123 and 2181. A fully qualified domain name cannot be more than 255 characters in length and must be made up of labels separated by the '.' character. Each label can be no more than 63 characters in length and is made up of characters from a limited character set.

The domain name specification allows for a trailing dot.

If these criteria are not met, an exception is thrown.

INTERFACE

Value::Object::Domain->new( $domstr )

Create a new domain name object if the supplied string is a valid domain name. Otherwise throw an exception.

Value::Object::Domain->new_canonical( $domstr )

Create a new domain name object if the supplied string is a valid domain name. Otherwise throw an exception.

Unlike the new method, the ASCII characters of the supplied $domstr are lowercased before the domain is created. The canonical version of the domain name is always lowercase.

$dom->value()

Returns a string that represents the domain name of the object.

$dom->make_subdomain( $label )

Create a new Value::Object::Domain object that is created when the supplied label is used as a subdomain of the domain represented by $dom.

CONFIGURATION AND ENVIRONMENT

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

DEPENDENCIES

Moo, namespace::clean

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-moox-value@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.

cpanm Value::Object

perl -MCPAN -e shell
install Value::Object