/ 
phpBB2-Simple-0.04
River stage one • 1 direct dependent • 1 total dependent
/ phpbb2

NAME

phpbb2 - API for phpBB2

VERSION

This document describes version 0.04 of phpbb2 (from Perl distribution phpBB2-Simple), released on 2017-07-10.

SYNOPSIS

Usage:

% phpbb2 add-user-to-groups [options] <user> <group> ...
% phpbb2 delete-user-from-all-forum-moderators [options] <user>
% phpbb2 delete-user-from-groups [options] <user> <group> ...
% phpbb2 list-group-members [options] <group>
% phpbb2 list-groups [options]
% phpbb2 list-user-groups [options] <user>
% phpbb2 list-users [options]

SUBCOMMANDS

add-user-to-groups

Add a user to one or more groups.

delete-user-from-all-forum-moderators

Delete a user from being moderator in all forums.

delete-user-from-groups

Delete a user from one or more groups.

list-group-members

list-groups

list-user-groups

List groups which user belongs to.

list-users

OPTIONS

* marks required options.

Common options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--db-dsn=s*
--db-password=s*
--db-user=s*
--format=s

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

Default value:

undef
--help, -h, -?

Display help message and exit.

--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]
--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--subcommands

List available subcommands.

--version, -v

Display program's version and exit.

Options for subcommand add-user-to-groups

--group-json=s

See --group.

--group=s@*

Can be specified multiple times.

--user=s*

Options for subcommand delete-user-from-all-forum-moderators

--user=s*

Options for subcommand delete-user-from-groups

--group-json=s

See --group.

--group=s@*

Can be specified multiple times.

--user=s*

Options for subcommand list-group-members

--group=s*

Options for subcommand list-groups

--detail

Returned detailed record for each item instead of just ID.

Options for subcommand list-user-groups

--user=s*

Options for subcommand list-users

--active

Only list active users.

--detail

Returned detailed record for each item instead of just ID.

--level=s

Only list users having certain level.

Valid values:

["user","moderator","administrator"]

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C phpbb2 phpbb2

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 phpbb2 'p/*/`phpbb2`/'

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/phpbb2.conf, ~/phpbb2.conf, or /etc/phpbb2.conf.

All found files will be read and merged.

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

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME 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.

Finally, you can 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.

List of available configuration parameters:

Common for all subcommands

db_dsn (see --db-dsn)
db_password (see --db-password)
db_user (see --db-user)
format (see --format)
naked_res (see --naked-res)

Configuration for subcommand add-user-to-groups

group (see --group)
user (see --user)

Configuration for subcommand delete-user-from-all-forum-moderators

user (see --user)

Configuration for subcommand delete-user-from-groups

group (see --group)
user (see --user)

Configuration for subcommand list-group-members

group (see --group)

Configuration for subcommand list-groups

detail (see --detail)

Configuration for subcommand list-user-groups

user (see --user)

Configuration for subcommand list-users

active (see --active)
detail (see --detail)
level (see --level)

ENVIRONMENT

PHPBB2_OPT => str

Specify additional command-line options.

FILES

~/.config/phpbb2.conf

~/phpbb2.conf

/etc/phpbb2.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/phpBB2-Simple.

SOURCE

Source repository is at https://github.com/perlancar/perl-phpBB2-Simple.

BUGS

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

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) 2017, 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.