/ 
Parse-PhoneNumber-ID-0.170
River stage one • 1 direct dependent • 1 total dependent
/ parse-idn-phone

NAME

parse-idn-phone - Alias for extract_idn_phones(..., max_numbers=>1)->[0]

VERSION

This document describes version 0.170 of parse-idn-phone (from Perl distribution Parse-PhoneNumber-ID), released on 2021-05-07.

SYNOPSIS

Usage:

% parse-idn-phone [--config-path=path | -c] [--config-profile=profile |
    -P] [--default-area-code=s] [--format=name] [--json] [--level=s]
    [--(no)naked-res] [--no-config | -C] [--no-env]
    [--page-result[=program]] [--view-result[=program]] <text>

DESCRIPTION

Extracts phone number(s) from text. Return an array of one or more parsed phone number structure (a hash). Understands the list of known area codes and cellular operators, as well as other information. Understands various syntax e.g. +62.22.1234567, (022) 123-4567, 022-123-4567 ext 102, and even things like 7123456/57 (2 adjacent numbers).

Extraction algorithm is particularly targetted at classified ads text in Indonesian language, but should be quite suitable for any other normal text.

Non-Indonesian phone numbers (e.g. +65 12 3456 7890) will still be extracted, but without any other detailed information other than country code.

OPTIONS

* marks required options.

Main options

--default-area-code=s

When encountering a number without area code, use this.

If you want to extract numbers that doesn't contain area code (e.g. 7123 4567), you'll need to provide this.

--level=s

How hard should the function extract numbers (1-9).

Default value:

5

The higher the level, the harder this function will try finding phone numbers, but the higher the risk of false positives will be. E.g. in text '123456789012345' with level=5 it will not find a phone number, but with level=9 it might assume, e.g. 1234567890 to be a phone number. Normally leaving level at default level is fine.

--text=s*

Text containing phone numbers to extract from.

Configuration options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--no-config, -C

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C parse-idn-phone parse-idn-phone

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete parse-idn-phone 'p/*/`parse-idn-phone`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/parse-idn-phone.conf, ~/parse-idn-phone.conf, or /etc/parse-idn-phone.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

default_area_code (see --default-area-code)
format (see --format)
level (see --level)
naked_res (see --naked-res)
text (see --text)

ENVIRONMENT

PARSE_IDN_PHONE_OPT => str

Specify additional command-line options.

FILES

~/.config/parse-idn-phone.conf

~/parse-idn-phone.conf

/etc/parse-idn-phone.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Parse-PhoneNumber-ID.

SOURCE

Source repository is at https://github.com/perlancar/perl-Parse-PhoneNumber-ID.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Parse-PhoneNumber-ID

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2017, 2015, 2014, 2013, 2012, 2011 by perlancar@cpan.org.

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