.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "GeoIP2::Model::Enterprise 3pm" .TH GeoIP2::Model::Enterprise 3pm "2022-11-21" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" GeoIP2::Model::Enterprise \- Model class for GeoIP2 Enterprise .SH "VERSION" .IX Header "VERSION" version 2.006002 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use 5.008; \& \& use GeoIP2::WebService::Client; \& \& my $reader = GeoIP2::Database::Reader\->new( \& file => \*(Aq/path/to/database\*(Aq, \& locales => [ \*(Aqen\*(Aq, \*(Aqde\*(Aq, ] \& ); \& \& my $enterprise = $reader\->enterprise( ip => \*(Aq24.24.24.24\*(Aq ); \& \& my $city_rec = $enterprise\->city(); \& print $city_rec\->name(), "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class provides a model for the data returned by the GeoIP2 Enterprise database. .PP The only difference between the City and Enterprise model classes is which fields in each record may be populated. See for more details. .SH "METHODS" .IX Header "METHODS" This class provides the following methods. .ie n .SS "$enterprise\->\fBcity()\fP" .el .SS "\f(CW$enterprise\fP\->\fBcity()\fP" .IX Subsection "$enterprise->city()" Returns a GeoIP2::Record::City object representing city data for the requested \s-1IP\s0 address. .ie n .SS "$enterprise\->\fBcontinent()\fP" .el .SS "\f(CW$enterprise\fP\->\fBcontinent()\fP" .IX Subsection "$enterprise->continent()" Returns a GeoIP2::Record::Continent object representing continent data for the requested \s-1IP\s0 address. .ie n .SS "$enterprise\->\fBcountry()\fP" .el .SS "\f(CW$enterprise\fP\->\fBcountry()\fP" .IX Subsection "$enterprise->country()" Returns a GeoIP2::Record::Country object representing country data for the requested \s-1IP\s0 address. This record represents the country where MaxMind believes the \s-1IP\s0 is located. .ie n .SS "$enterprise\->\fBlocation()\fP" .el .SS "\f(CW$enterprise\fP\->\fBlocation()\fP" .IX Subsection "$enterprise->location()" Returns a GeoIP2::Record::Location object representing location data for the requested \s-1IP\s0 address. .ie n .SS "$enterprise\->\fBpostal()\fP" .el .SS "\f(CW$enterprise\fP\->\fBpostal()\fP" .IX Subsection "$enterprise->postal()" Returns a GeoIP2::Record::Postal object representing postal code data for the requested \s-1IP\s0 address. .ie n .SS "$enterprise\->\fBregistered_country()\fP" .el .SS "\f(CW$enterprise\fP\->\fBregistered_country()\fP" .IX Subsection "$enterprise->registered_country()" Returns a GeoIP2::Record::Country object representing the registered country data for the requested \s-1IP\s0 address. This record represents the country where the \s-1ISP\s0 has registered a given \s-1IP\s0 block and may differ from the user's country. .ie n .SS "$enterprise\->\fBrepresented_country()\fP" .el .SS "\f(CW$enterprise\fP\->\fBrepresented_country()\fP" .IX Subsection "$enterprise->represented_country()" Returns a GeoIP2::Record::RepresentedCountry object for the country represented by the requested \s-1IP\s0 address. The represented country may differ from the \f(CW\*(C`country\*(C'\fR for things like military bases. .ie n .SS "$enterprise\->\fBsubdivisions()\fP" .el .SS "\f(CW$enterprise\fP\->\fBsubdivisions()\fP" .IX Subsection "$enterprise->subdivisions()" Returns an array of GeoIP2::Record::Subdivision objects representing the country subdivisions for the requested \s-1IP\s0 address. The number and type of subdivisions varies by country, but a subdivision is typically a state, province, county, etc. .PP Some countries have multiple levels of subdivisions. For instance, the subdivisions array for Oxford in the United Kingdom would have England as the first element and Oxfordshire as the second element. The subdivisions array for Minneapolis in the United States would have a single object for Minnesota. .PP If the response did not contain any subdivisions, this method returns an empty list. .ie n .SS "$enterprise\->\fBmost_specific_subdivision()\fP" .el .SS "\f(CW$enterprise\fP\->\fBmost_specific_subdivision()\fP" .IX Subsection "$enterprise->most_specific_subdivision()" Returns a single GeoIP2::Record::Subdivision object representing the most specific subdivision returned. .PP If the response did not contain any subdivisions, this method returns a GeoIP2::Record::Subdivision object with no values. .ie n .SS "$enterprise\->\fBtraits()\fP" .el .SS "\f(CW$enterprise\fP\->\fBtraits()\fP" .IX Subsection "$enterprise->traits()" Returns a GeoIP2::Record::Traits object representing the traits for the requested \s-1IP\s0 address. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through . .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Dave Rolsky .IP "\(bu" 4 Greg Oschwald .IP "\(bu" 4 Mark Fowler .IP "\(bu" 4 Olaf Alders .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 \- 2019 by MaxMind, Inc. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.