NAME
App::ListSoftwareLicenses - List all Software::License's
VERSION
This document describes version 0.02 of App::ListSoftwareLicenses (from Perl distribution App-ListSoftwareLicenses), released on 2014-06-29.
FUNCTIONS
list_software_licenses(%args) -> [status, msg, result, meta]
List all Software::License's.
Examples:
list_software_licenses( q => "perl");String search.
REPLACE ME
Arguments ('*' denotes required arguments):
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.
fields => array
Select fields to return.
meta2_name => str
Only return records where the 'meta2_name' field equals specified value.
meta2_name.contains => str
Only return records where the 'meta2_name' field contains specified text.
meta2_name.in => array
Only return records where the 'meta2_name' field is in the specified values.
meta2_name.is => str
Only return records where the 'meta2_name' field equals specified value.
meta2_name.isnt => str
Only return records where the 'meta2_name' field does not equal specified value.
meta2_name.max => str
Only return records where the 'meta2_name' field is less than or equal to specified value.
meta2_name.min => str
Only return records where the 'meta2_name' field is greater than or equal to specified value.
meta2_name.not_contains => str
Only return records where the 'meta2_name' field does not contain specified text.
meta2_name.not_in => array
Only return records where the 'meta2_name' field is not in the specified values.
meta2_name.xmax => str
Only return records where the 'meta2_name' field is less than specified value.
meta2_name.xmin => str
Only return records where the 'meta2_name' field is greater than specified value.
meta_name => str
Only return records where the 'meta_name' field equals specified value.
meta_name.contains => str
Only return records where the 'meta_name' field contains specified text.
meta_name.in => array
Only return records where the 'meta_name' field is in the specified values.
meta_name.is => str
Only return records where the 'meta_name' field equals specified value.
meta_name.isnt => str
Only return records where the 'meta_name' field does not equal specified value.
meta_name.max => str
Only return records where the 'meta_name' field is less than or equal to specified value.
meta_name.min => str
Only return records where the 'meta_name' field is greater than or equal to specified value.
meta_name.not_contains => str
Only return records where the 'meta_name' field does not contain specified text.
meta_name.not_in => array
Only return records where the 'meta_name' field is not in the specified values.
meta_name.xmax => str
Only return records where the 'meta_name' field is less than specified value.
meta_name.xmin => str
Only return records where the 'meta_name' field is greater than specified value.
module => str
Only return records where the 'module' field equals specified value.
module.contains => str
Only return records where the 'module' field contains specified text.
module.in => array
Only return records where the 'module' field is in the specified values.
module.is => str
Only return records where the 'module' field equals specified value.
module.isnt => str
Only return records where the 'module' field does not equal specified value.
module.max => str
Only return records where the 'module' field is less than or equal to specified value.
module.min => str
Only return records where the 'module' field is greater than or equal to specified value.
module.not_contains => str
Only return records where the 'module' field does not contain specified text.
module.not_in => array
Only return records where the 'module' field is not in the specified values.
module.xmax => str
Only return records where the 'module' field is less than specified value.
module.xmin => str
Only return records where the 'module' field is greater than specified value.
name => str
Only return records where the 'name' field equals specified value.
name.contains => str
Only return records where the 'name' field contains specified text.
name.in => array
Only return records where the 'name' field is in the specified values.
name.is => str
Only return records where the 'name' field equals specified value.
name.isnt => str
Only return records where the 'name' field does not equal specified value.
name.max => str
Only return records where the 'name' field is less than or equal to specified value.
name.min => str
Only return records where the 'name' field is greater than or equal to specified value.
name.not_contains => str
Only return records where the 'name' field does not contain specified text.
name.not_in => array
Only return records where the 'name' field is not in the specified values.
name.xmax => str
Only return records where the 'name' field is less than specified value.
name.xmin => str
Only return records where the 'name' field is greater than specified value.
notice => str
Only return records where the 'notice' field equals specified value.
notice.contains => str
Only return records where the 'notice' field contains specified text.
notice.in => array
Only return records where the 'notice' field is in the specified values.
notice.is => str
Only return records where the 'notice' field equals specified value.
notice.isnt => str
Only return records where the 'notice' field does not equal specified value.
notice.max => str
Only return records where the 'notice' field is less than or equal to specified value.
notice.min => str
Only return records where the 'notice' field is greater than or equal to specified value.
notice.not_contains => str
Only return records where the 'notice' field does not contain specified text.
notice.not_in => array
Only return records where the 'notice' field is not in the specified values.
notice.xmax => str
Only return records where the 'notice' field is less than specified value.
notice.xmin => str
Only return records where the 'notice' field is greater than specified value.
q => str
Search.
sort => 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.
text => str
Only return records where the 'text' field equals specified value.
text.contains => str
Only return records where the 'text' field contains specified text.
text.in => array
Only return records where the 'text' field is in the specified values.
text.is => str
Only return records where the 'text' field equals specified value.
text.isnt => str
Only return records where the 'text' field does not equal specified value.
text.max => str
Only return records where the 'text' field is less than or equal to specified value.
text.min => str
Only return records where the 'text' field is greater than or equal to specified value.
text.not_contains => str
Only return records where the 'text' field does not contain specified text.
text.not_in => array
Only return records where the 'text' field is not in the specified values.
text.xmax => str
Only return records where the 'text' field is less than specified value.
text.xmin => str
Only return records where the 'text' field is greater than specified value.
url => str
Only return records where the 'url' field equals specified value.
url.contains => str
Only return records where the 'url' field contains specified text.
url.in => array
Only return records where the 'url' field is in the specified values.
url.is => str
Only return records where the 'url' field equals specified value.
url.isnt => str
Only return records where the 'url' field does not equal specified value.
url.max => str
Only return records where the 'url' field is less than or equal to specified value.
url.min => str
Only return records where the 'url' field is greater than or equal to specified value.
url.not_contains => str
Only return records where the 'url' field does not contain specified text.
url.not_in => array
Only return records where the 'url' field is not in the specified values.
url.xmax => str
Only return records where the 'url' field is less than specified value.
url.xmin => str
Only return records where the 'url' field is greater than specified value.
version => str
Only return records where the 'version' field equals specified value.
version.contains => str
Only return records where the 'version' field contains specified text.
version.in => array
Only return records where the 'version' field is in the specified values.
version.is => str
Only return records where the 'version' field equals specified value.
version.isnt => str
Only return records where the 'version' field does not equal specified value.
version.max => str
Only return records where the 'version' field is less than or equal to specified value.
version.min => str
Only return records where the 'version' field is greater than or equal to specified value.
version.not_contains => str
Only return records where the 'version' field does not contain specified text.
version.not_in => array
Only return records where the 'version' field is not in the specified values.
version.xmax => str
Only return records where the 'version' field is less than specified value.
version.xmin => str
Only return records where the 'version' field is greater than specified value.
with.text => bool (default: 0)
Show field 'with'.
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, ...).
Return 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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
SEE ALSO
App::Software::License to print out license text
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-ListSoftwareLicenses.
SOURCE
Source repository is at https://github.com/sharyanto/perl-App-ListSoftwareLicenses.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ListSoftwareLicenses
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
Steven Haryanto <stevenharyanto@gmail.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Steven Haryanto.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.