.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "Number::Phone::UK 3pm" .TH Number::Phone::UK 3pm 2024-03-24 "perl v5.38.2" "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 Number::Phone::UK \- UK\-specific methods for Number::Phone .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Number::Phone; \& \& $daves_phone = Number::Phone\->new(\*(Aq+44 1234 567890\*(Aq); .Ve .SH DATABASE .IX Header "DATABASE" Number::Phone::UK uses a large database, access via Number::Phone::UK::Data. This database lives in a file, and normally only the little bits of it that you access will ever get loaded into memory. This means, however, that creating Number::Phone::UK objects almost always involves disk access and so is slow compared to data for some other countries. There are two ways to avoid this slowness. .PP First, if you don't need all the functionality you can use Number::Phone::Lib. .PP Second, if you can accept slow startup \- eg when your server starts \- then you can call \&\f(CW\*(C`Number::Phone::UK::Data\->slurp()\*(C'\fR from your code, which will pull the entire database into memory. This will take a few minutes, and on a 64\-bit machine will consume of the order of 200MB of memory. .PP The database uses Data::CompactReadonly. This may have some problems if you connect to it, \&\f(CWfork()\fR, and then try to access the database from multiple processes. We attempt to work around this by re-connecting to the database after forking. This is, of course, not a problem if you \f(CWslurp()\fR the database before forking. .SH METHODS .IX Header "METHODS" The following methods from Number::Phone are overridden: .IP new 4 .IX Item "new" The constructor, you should never have to call this yourself. To create an object the canonical incantation is \f(CW\*(C`Number::Phone\->new(\*(Aq+44 ...\*(Aq)\*(C'\fR. .IP data_source 4 .IX Item "data_source" Returns a string telling where and when the data that drives this class was last updated, looking something like: .Sp .Vb 1 \& "OFCOM at Wed Sep 30 10:37:39 2020 UTC" .Ve .Sp The current value of this is also documented in Number::Phone::Data. .IP is_valid 4 .IX Item "is_valid" The number is valid within the national numbering scheme. It may or may not yet be allocated, or it may be reserved. Any number which returns true for any of the following methods will also be valid. .IP is_allocated 4 .IX Item "is_allocated" The number has been allocated to a telco for use. It may or may not yet be in use or may be reserved. .IP is_drama 4 .IX Item "is_drama" The number is intended for use in fiction. OFCOM has allocated numerous small ranges for this purpose. These numbers will not be allocated to real customers. See for the authoritative source. .IP is_geographic 4 .IX Item "is_geographic" The number refers to a geographic area. .IP is_fixed_line 4 .IX Item "is_fixed_line" The number, when in use, can only refer to a fixed line. .Sp (we can't tell whether a number is a fixed line, but we can tell that some are *not*). .IP is_mobile 4 .IX Item "is_mobile" The number, when in use, can only refer to a mobile phone. .IP is_pager 4 .IX Item "is_pager" The number, when in use, can only refer to a pager. .IP is_tollfree 4 .IX Item "is_tollfree" Callers will not be charged for calls to this number under normal circumstances. .IP is_specialrate 4 .IX Item "is_specialrate" The number, when in use, attracts special rates. For instance, national dialling at local rates, or premium rates for services. .IP is_adult 4 .IX Item "is_adult" The number, when in use, goes to a service of an adult nature, such as porn. .IP is_personal 4 .IX Item "is_personal" The number, when in use, goes to an individual person. .IP is_corporate 4 .IX Item "is_corporate" The number, when in use, goes to a business. .IP is_ipphone 4 .IX Item "is_ipphone" The number, when in use, is terminated using VoIP. .IP is_network_service 4 .IX Item "is_network_service" The number is some kind of network service such as a human operator, directory enquiries, emergency services etc .IP country_code 4 .IX Item "country_code" Returns 44. .IP regulator 4 .IX Item "regulator" Returns informational text. .IP areacode 4 .IX Item "areacode" Return the area code \- if applicable \- for the number. If not applicable, returns undef. .IP areaname 4 .IX Item "areaname" Return the area name \- if applicable \- for the number, or undef. .IP location 4 .IX Item "location" For geographic numbers, this returns the location of the exchange to which that number is assigned, if available. Otherwise returns undef. .IP subscriber 4 .IX Item "subscriber" Return the subscriber part of the number .IP operator 4 .IX Item "operator" Return the name of the telco operating this number, in an appropriate character set and with optional details such as their web site or phone number. .IP format 4 .IX Item "format" Return a sanely formatted version of the number, complete with IDD code, eg for the UK number (0208) 771\-2924 it would return +44 20 8771 2924. .IP intra_country_dial_to 4 .IX Item "intra_country_dial_to" Within the UK numbering plan you can *always* dial 0xxxx xxxxxx for intra-country calls. In most places the leading 0$areacode is optional but in some it is required (see eg ) and over time this will apply to more areas. .IP country 4 .IX Item "country" If the number is_international, return the two-letter ISO country code. .Sp NYI .SH LIMITATIONS/BUGS/FEEDBACK .IX Header "LIMITATIONS/BUGS/FEEDBACK" The results are only as up-to-date as the data included from OFCOM's official documentation of number range allocations. .PP No attempt is made to deal with number portability. .PP Please report bugs at , including, if possible, a test case. .PP I welcome feedback from users. .SH LICENCE .IX Header "LICENCE" You may use, modify and distribute this software under the same terms as perl itself. .SH AUTHOR .IX Header "AUTHOR" David Cantrell .PP Copyright 2024