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 => 'bigint',
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> or C<bigint>, it's assumed to be numeric, while
52 C<inet> and C<cidr> (as used by e.g. PostgreSQL) are assumed to be
61 =item Arguments: $class
65 Gets/sets the address class that the columns should be inflated into.
66 The default class is NetAddr::IP.
72 =item Arguments: $format
76 Gets/sets the name of the method used to deflate the address for the
77 database. This must return a value suitable for C<$ip_class->new(); The
78 default format is C<addr>, which returns the address in dotted-quad
79 notation. See L<NetAddr::IP/Methods> for suitable values.
81 =head2 register_column
83 Chains with L<DBIx::Class::Row/register_column>, and sets up IP address
84 columns appropriately. This would not normally be called directly by end
90 my ($self, $column, $info, @rest) = @_;
91 $self->next::method($column, $info, @rest);
93 return unless defined $info->{'is_ip'};
95 my $ip_format = $info->{ip_format} || _default_format($info->{data_type})
96 || $self->ip_format || 'addr';
97 my $ip_class = $info->{ip_class} || $self->ip_class || 'NetAddr::IP';
100 $self->throw_exception("Error loading $ip_class: $@") if $@;
101 $self->throw_exception("Format '$ip_format' not supported by $ip_class")
102 unless $ip_class->can($ip_format);
104 $self->inflate_column(
106 inflate => sub { return $ip_class->new(shift); },
107 deflate => sub { return scalar shift->$ip_format; },
113 { type => qr/^(?:big)?int/i, format => 'numeric' },
114 { type => qr{^(?:inet|cidr)$}i, format => 'cidr' },
117 sub _default_format {
120 for my $match (@format_map) {
121 return $match->{format} if $type =~ $match->{type};
127 Dagfinn Ilmari Mannsåker, C<< <ilmari at ilmari.org> >>
131 Please report any bugs or feature requests to
132 C<bug-dbix-class-inflatecolumn-ip at rt.cpan.org>, or through the web interface at
133 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DBIx-Class-InflateColumn-IP>.
134 I will be notified, and then you'll automatically be notified of progress on
135 your bug as I make changes.
139 You can find documentation for this module with the perldoc command.
141 perldoc DBIx::Class::InflateColumn::IP
143 You can also look for information at:
147 =item * AnnoCPAN: Annotated CPAN documentation
149 L<http://annocpan.org/dist/DBIx-Class-InflateColumn-IP>
153 L<http://cpanratings.perl.org/d/DBIx-Class-InflateColumn-IP>
155 =item * RT: CPAN's request tracker
157 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=DBIx-Class-InflateColumn-IP>
161 L<http://search.cpan.org/dist/DBIx-Class-InflateColumn-IP>
167 L<DBIx::Class>, L<NetAddr::IP>
169 =head1 COPYRIGHT & LICENSE
171 Copyright 2007 Dagfinn Ilmari Mannsåker, all rights reserved.
173 This program is free software; you can redistribute it and/or modify it
174 under the same terms as Perl itself.
178 1; # End of DBIx::Class::InflateColumn::IP