The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Parse-PhoneNumber-ID-0.14
River stage one • 1 direct dependent • 1 total dependent
++
/ parse-id-phone

NAME

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

VERSION

This document describes version 0.14 of parse-id-phone (from Perl distribution Parse-PhoneNumber-ID), released on 2015-08-18.

SYNOPSIS

Usage:

 % parse-id-phone [options] <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.

Configuration options

--config-path=filename

{en_US Set path to configuration file}.

Can be specified multiple times.

--config-profile=s

{en_US Set configuration profile to use}.

--no-config

{en_US Do not use any configuration file}.

Environment options

--no-env

{en_US Do not read environment for default options}.

Output options

--format=s

{en_US Choose output format, e.g. json, text}.

Default value:

 undef
--json

{en_US Set output format to json}.

--naked-res

{en_US When outputing as JSON, strip result envelope}.

Default value:

 0

{en_US 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]
}

Other options

--default-area-code=s

{en_US When encountering a number without area code, use this}.

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

--help, -h, -?

{en_US Display help message and exit}.

--level=i

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

Default value:

 5

{en_US 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*

{en_US Text containing phone numbers to extract from}.

--version, -v

{en_US 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-id-phone parse-id-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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete parse-id-phone 'p/*/`parse-id-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.

ENVIRONMENT

PARSE_ID_PHONE_OPT => str

Specify additional command-line options

CONFIGURATION FILE

This script can read configuration file, which by default is searched at ~/.config/parse-id-phone.conf, ~/parse-id-phone.conf or /etc/parse-id-phone.conf (can be changed by specifying --config-path). All found files will be read and merged.

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

Configuration file is in the format of IOD, which is basically INI with some extra features.

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

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)

FILES

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

~/parse-id-phone.conf

/etc/parse-id-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) 2015 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.