.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Number::Phone::NANP 3" .TH Number::Phone::NANP 3 "2009-03-07" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Number::Phone::NANP \- NANP\-specific methods for Number::Phone .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a base class which encapsulates that information about phone numbers in the North American Numbering Plan (\s-1NANP\s0) which are common to all \s-1NANP\s0 countries \- that is, those whose international dialling code is +1. If you are dealing with phone numbers in any of those countries, you should \f(CW\*(C`use\*(C'\fR this module. It will then load the country-specific modules for you as needed. .PP Country-specific modules should inherit from this module and provide their own versions of methods as necessary. However, they should not provide an \f(CW\*(C`is_valid\*(C'\fR method or a constructor. .SH "SYNOPSIS" .IX Header "SYNOPSIS" in a program: .PP .Vb 1 \& use Number::Phone::NANP; .Ve .PP .Vb 2 \& my $phone_number = Number::Phone->new('+1 202 418 1440'); \& # $phone_number is now a Number::Phone::NANP::US .Ve .PP .Vb 2 \& my $other_phone_number = Number::Phone->new('+1 866 623 2282'); \& # $phone_number is non-geographic so is a Number::Phone::NANP .Ve .PP in a subclass: .PP .Vb 2 \& package Number::Phone::NANP::CA; \& use base 'Number::Phone::NANP'; .Ve .SH "METHODS" .IX Header "METHODS" The following methods from Number::Phone are overridden: .IP "is_valid" 4 .IX Item "is_valid" The number is valid within the numbering scheme. It may or may not yet be allocated, or it may be reserved. .IP "country_code" 4 .IX Item "country_code" Returns 1. .IP "regulator" 4 .IX Item "regulator" Returns informational text relevant to the whole \s-1NANP\s0. Note that when this method is inherited by a subclass it returns undef meaning \*(L"not known\*(R", but returns information about the \s-1NANPA\s0 when called on an object of class Number::Phone::NANP. .IP "areacode" 4 .IX Item "areacode" Return the area code for the number. .IP "subscriber" 4 .IX Item "subscriber" Return the subscriber part of the number. .IP "format" 4 .IX Item "format" Return a sanely formatted version of the number, complete with \s-1IDD\s0 code. .SH "BUGS/FEEDBACK" .IX Header "BUGS/FEEDBACK" Please report bugs by email, 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 2005