phpbb2 - API for phpBB2
This document describes version 0.01 of phpbb2 (from Perl distribution phpBB2-Simple), released on 2015-03-06.
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]
Add a user to one or more groups.
Delete a user from being moderator in all forums.
Delete a user from one or more groups.
List groups which user belongs to.
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Choose output format, e.g. json, text.
Display this help message.
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Do not use any configuration file.
List available subcommands.
See --group.
--group
Returned detailed record for each item instead of just ID.
Only list active users.
Only list users having certain level.
Valid values:
["user", "moderator", "administrator"]
PHPBB2_OPT
~/phpbb2.conf
/etc/phpbb2.conf
This script has shell tab completion capability with support for several shells.
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.
~/.bashrc
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.
shcompgen
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/phpBB2-Simple.
Source repository is at https://github.com/perlancar/perl-phpBB2-Simple.
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.
perlancar <perlancar@cpan.org>
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.
To install phpBB2::Simple, copy and paste the appropriate command in to your terminal.
cpanm
cpanm phpBB2::Simple
CPAN shell
perl -MCPAN -e shell install phpBB2::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.