/ 
Business-Address-POBox-0.01
River stage zero No dependents
/ Business::Address::POBox

NAME

Business::Address::POBox - Check whether an address looks like a P.O.Box

SYNOPSIS

use Business::Address::POBox;

if (Business::Address::POBox->new->is_pobox($address)) {
    ...
}

DESCRIPTION

This class tries to determine whether or not an string refers to a P.O. box. This is sometims relevant if your business process, for legal reasons, needs a real address and not a P.O. box.

It has predefined blacklists and whitelists that should catch most english and german P.O. box addresses, but you can modify these lists with the methods provided.

Business::Address::POBox inherits from Class::Accessor::Complex, Class::Accessor::Constructor, Class::Accessor::Constructor::Base.

METHODS

blacklist
my @values    = $obj->blacklist;
my $array_ref = $obj->blacklist;
$obj->blacklist(@values);
$obj->blacklist($array_ref);

Get or set the array values. If called without an arguments, it returns the array in list context, or a reference to the array in scalar context. If called with arguments, it expands array references found therein and sets the values. =item blacklist_clear

$obj->blacklist_clear;

Deletes all elements from the array. =item blacklist_count

my $count = $obj->blacklist_count;

Returns the number of elements in the array. =item blacklist_index

my $element   = $obj->blacklist_index(3);
my @elements  = $obj->blacklist_index(@indices);
my $array_ref = $obj->blacklist_index(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context. =item blacklist_pop

my $value = $obj->blacklist_pop;

Pops the last element off the array, returning it. =item blacklist_push

$obj->blacklist_push(@values);

Pushes elements onto the end of the array. =item blacklist_set

$obj->blacklist_set(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set. =item blacklist_shift

my $value = $obj->blacklist_shift;

Shifts the first element off the array, returning it. =item blacklist_splice

$obj->blacklist_splice(2, 1, $x, $y);
$obj->blacklist_splice(-1);
$obj->blacklist_splice(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array. =item blacklist_unshift

$obj->blacklist_unshift(@values);

Unshifts elements onto the beginning of the array. =item clear_blacklist

$obj->clear_blacklist;

Deletes all elements from the array. =item clear_whitelist

$obj->clear_whitelist;

Deletes all elements from the array. =item count_blacklist

my $count = $obj->count_blacklist;

Returns the number of elements in the array. =item count_whitelist

my $count = $obj->count_whitelist;

Returns the number of elements in the array. =item index_blacklist

my $element   = $obj->index_blacklist(3);
my @elements  = $obj->index_blacklist(@indices);
my $array_ref = $obj->index_blacklist(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context. =item index_whitelist

my $element   = $obj->index_whitelist(3);
my @elements  = $obj->index_whitelist(@indices);
my $array_ref = $obj->index_whitelist(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context. =item pop_blacklist

my $value = $obj->pop_blacklist;

Pops the last element off the array, returning it. =item pop_whitelist

my $value = $obj->pop_whitelist;

Pops the last element off the array, returning it. =item push_blacklist

$obj->push_blacklist(@values);

Pushes elements onto the end of the array. =item push_whitelist

$obj->push_whitelist(@values);

Pushes elements onto the end of the array. =item set_blacklist

$obj->set_blacklist(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set. =item set_whitelist

$obj->set_whitelist(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set. =item shift_blacklist

my $value = $obj->shift_blacklist;

Shifts the first element off the array, returning it. =item shift_whitelist

my $value = $obj->shift_whitelist;

Shifts the first element off the array, returning it. =item splice_blacklist

$obj->splice_blacklist(2, 1, $x, $y);
$obj->splice_blacklist(-1);
$obj->splice_blacklist(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array. =item splice_whitelist

$obj->splice_whitelist(2, 1, $x, $y);
$obj->splice_whitelist(-1);
$obj->splice_whitelist(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array. =item unshift_blacklist

$obj->unshift_blacklist(@values);

Unshifts elements onto the beginning of the array. =item unshift_whitelist

$obj->unshift_whitelist(@values);

Unshifts elements onto the beginning of the array. =item whitelist

my @values    = $obj->whitelist;
my $array_ref = $obj->whitelist;
$obj->whitelist(@values);
$obj->whitelist($array_ref);

Get or set the array values. If called without an arguments, it returns the array in list context, or a reference to the array in scalar context. If called with arguments, it expands array references found therein and sets the values. =item whitelist_clear

$obj->whitelist_clear;

Deletes all elements from the array. =item whitelist_count

my $count = $obj->whitelist_count;

Returns the number of elements in the array. =item whitelist_index

my $element   = $obj->whitelist_index(3);
my @elements  = $obj->whitelist_index(@indices);
my $array_ref = $obj->whitelist_index(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context. =item whitelist_pop

my $value = $obj->whitelist_pop;

Pops the last element off the array, returning it. =item whitelist_push

$obj->whitelist_push(@values);

Pushes elements onto the end of the array. =item whitelist_set

$obj->whitelist_set(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set. =item whitelist_shift

my $value = $obj->whitelist_shift;

Shifts the first element off the array, returning it. =item whitelist_splice

$obj->whitelist_splice(2, 1, $x, $y);
$obj->whitelist_splice(-1);
$obj->whitelist_splice(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array. =item whitelist_unshift

$obj->whitelist_unshift(@values);

Unshifts elements onto the beginning of the array.

update

Call this method when you've changed the whitelist() or the blacklist() so the matcher knows about the changes.

is_pobox

This is the central method of this class. It takes a string argument and checks it against the whitelist and the blacklist. Returns a boolean value - true if the string passes the whitelist or is at least not caught by the blacklist, false if the string is caught by the blacklist.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the businessaddresspobox tag.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to <bug-business-address-pobox@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.