1 package DBIx::Class::InflateColumn::IP;
6 our $VERSION = '0.02001';
8 use base qw/DBIx::Class/;
9 __PACKAGE__->mk_classdata(ip_format => 'addr');
10 __PACKAGE__->mk_classdata(ip_class => 'NetAddr::IP');
14 DBIx::Class::InflateColumn::IP - Auto-create NetAddr::IP objects from columns.
18 Load this component and declare columns as IP addresses with the
22 __PACKAGE__->load_components(qw/InflateColumn::IP Core/);
23 __PACKAGE__->add_columns(
25 data_type => 'integer',
28 ip_format => 'numeric',
33 __PACKAGE__->load_components(qw/InflateColumn::IP Core/);
34 __PACKAGE__->add_columns(
36 data_type => 'varchar',
44 Then you can treat the specified column as a NetAddr::IP object.
46 print 'IP address: ', $host->ip_address->addr;
47 print 'Address type: ', $host->ip_address->iptype;
49 DBIx::Class::InflateColumn::IP supports a limited amount of
50 auto-detection of the format based on the column type. If the type
51 begins with C<int>, it's assumed to be numeric, while C<inet> and
52 C<cidr> (as used by e.g. PostgreSQL) are assumed to be C<cidr> format.
60 =item Arguments: $class
64 Gets/sets the address class that the columns should be inflated into.
65 The default class is NetAddr::IP.
71 =item Arguments: $format
75 Gets/sets the name of the method used to deflate the address for the
76 database. This must return a value suitable for C<$ip_class->new(); The
77 default format is C<addr>, which returns the address in dotted-quad
78 notation. See L<NetAddr::IP/Methods> for suitable values.
80 =head2 register_column
82 Chains with L<DBIx::Class::Row/register_column>, and sets up IP address
83 columns appropriately. This would not normally be called directly by end
89 my ($self, $column, $info, @rest) = @_;
90 $self->next::method($column, $info, @rest);
92 return unless defined $info->{'is_ip'};
94 my $ip_format = $info->{ip_format} || _default_format($info->{data_type})
95 || $self->ip_format || 'addr';
96 my $ip_class = $info->{ip_class} || $self->ip_class || 'NetAddr::IP';
99 $self->throw_exception("Error loading $ip_class: $@") if $@;
100 $self->throw_exception("Format '$ip_format' not supported by $ip_class")
101 unless $ip_class->can($ip_format);
103 $self->inflate_column(
105 inflate => sub { return $ip_class->new(shift); },
106 deflate => sub { return scalar shift->$ip_format; },
112 { type => qr/^int/i, format => 'numeric' },
113 { type => qr{^(?:inet|cidr)$}i, format => 'cidr' },
116 sub _default_format {
119 for my $match (@format_map) {
120 return $match->{format} if $type =~ $match->{type};
126 Dagfinn Ilmari Mannsåker, C<< <ilmari at ilmari.org> >>
130 Please report any bugs or feature requests to
131 C<bug-dbix-class-inflatecolumn-ip at rt.cpan.org>, or through the web interface at
132 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DBIx-Class-InflateColumn-IP>.
133 I will be notified, and then you'll automatically be notified of progress on
134 your bug as I make changes.
138 You can find documentation for this module with the perldoc command.
140 perldoc DBIx::Class::InflateColumn::IP
142 You can also look for information at:
146 =item * AnnoCPAN: Annotated CPAN documentation
148 L<http://annocpan.org/dist/DBIx-Class-InflateColumn-IP>
152 L<http://cpanratings.perl.org/d/DBIx-Class-InflateColumn-IP>
154 =item * RT: CPAN's request tracker
156 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class-InflateColumn-IP>
160 L<http://search.cpan.org/dist/DBIx-Class-InflateColumn-IP>
166 L<DBIx::Class>, L<NetAddr::IP>
168 =head1 COPYRIGHT & LICENSE
170 Copyright 2007 Dagfinn Ilmari Mannsåker, all rights reserved.
172 This program is free software; you can redistribute it and/or modify it
173 under the same terms as Perl itself.
177 1; # End of DBIx::Class::InflateColumn::IP