App-ListLanguages
view release on metacpan or search on metacpan
NAME
App::ListLanguages - List languages
VERSION
This document describes version 0.005 of App::ListLanguages (from Perl
distribution App-ListLanguages), released on 2019-09-28.
SYNOPSIS
# Use via list-languages CLI script
FUNCTIONS
list_languages
Usage:
list_languages(%args) -> [status, msg, payload, meta]
List languages.
Source data is generated from "Locale::Codes::Language_Codes". so make
sure you have a relatively recent version of the module.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
* alpha2 => *str*
Only return records where the 'alpha2' field equals specified value.
* alpha2.contains => *str*
Only return records where the 'alpha2' field contains specified
text.
* alpha2.in => *array[str]*
Only return records where the 'alpha2' field is in the specified
values.
* alpha2.is => *str*
Only return records where the 'alpha2' field equals specified value.
* alpha2.isnt => *str*
Only return records where the 'alpha2' field does not equal
specified value.
* alpha2.max => *str*
Only return records where the 'alpha2' field is less than or equal
to specified value.
* alpha2.min => *str*
Only return records where the 'alpha2' field is greater than or
equal to specified value.
* alpha2.not_contains => *str*
Only return records where the 'alpha2' field does not contain
specified text.
* alpha2.not_in => *array[str]*
Only return records where the 'alpha2' field is not in the specified
values.
* alpha2.xmax => *str*
Only return records where the 'alpha2' field is less than specified
value.
* alpha2.xmin => *str*
Only return records where the 'alpha2' field is greater than
specified value.
* alpha3 => *str*
Only return records where the 'alpha3' field equals specified value.
* alpha3.contains => *str*
Only return records where the 'alpha3' field contains specified
text.
* alpha3.in => *array[str]*
Only return records where the 'alpha3' field is in the specified
values.
* alpha3.is => *str*
Only return records where the 'alpha3' field equals specified value.
* alpha3.isnt => *str*
Only return records where the 'alpha3' field does not equal
specified value.
* alpha3.max => *str*
Only return records where the 'alpha3' field is less than or equal
to specified value.
* alpha3.min => *str*
Only return records where the 'alpha3' field is greater than or
equal to specified value.
* alpha3.not_contains => *str*
Only return records where the 'alpha3' field does not contain
specified text.
* alpha3.not_in => *array[str]*
Only return records where the 'alpha3' field is not in the specified
values.
* alpha3.xmax => *str*
Only return records where the 'alpha3' field is less than specified
value.
* alpha3.xmin => *str*
Only return records where the 'alpha3' field is greater than
specified value.
* detail => *bool* (default: 0)
Return array of full records instead of just ID fields.
By default, only the key (ID) field is returned per result entry.
* en_name => *str*
Only return records where the 'en_name' field equals specified
value.
* en_name.contains => *str*
Only return records where the 'en_name' field contains specified
text.
* en_name.in => *array[str]*
Only return records where the 'en_name' field is in the specified
values.
* en_name.is => *str*
Only return records where the 'en_name' field equals specified
value.
* en_name.isnt => *str*
Only return records where the 'en_name' field does not equal
specified value.
* en_name.max => *str*
Only return records where the 'en_name' field is less than or equal
to specified value.
* en_name.min => *str*
Only return records where the 'en_name' field is greater than or
equal to specified value.
* en_name.not_contains => *str*
Only return records where the 'en_name' field does not contain
specified text.
* en_name.not_in => *array[str]*
Only return records where the 'en_name' field is not in the
specified values.
* en_name.xmax => *str*
Only return records where the 'en_name' field is less than specified
value.
* en_name.xmin => *str*
Only return records where the 'en_name' field is greater than
specified value.
* fields => *array[str]*
Select fields to return.
* query => *str*
Search.
* random => *bool* (default: 0)
Return records in random order.
* result_limit => *int*
Only return a certain number of records.
* result_start => *int* (default: 1)
Only return starting from the n'th record.
* sort => *array[str]*
Order records according to certain field(s).
A list of field names separated by comma. Each field can be prefixed
with '-' to specify descending order instead of the default
ascending.
* with_field_names => *bool*
Return field names in each record (as hash/associative array).
When enabled, function will return each record as hash/associative
array (field name => value pairs). Otherwise, function will return
each record as list/array (field value, field value, ...).
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
( run in 1.005 second using v1.01-cache-2.11-cpan-39bf76dae61 )