Ian Clark > WWW-phpBB-Mod-Installer-0.03 > WWW::phpBB::Mod::Installer

Download:
WWW-phpBB-Mod-Installer-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

WWW::phpBB::Mod::Installer - Perl extension for installing mods onto phpBB.

SYNOPSIS ^

  use WWW::phpBB::Mod::Installer;

  install_phpbb_mod(
                    INSTALL_FILE => '/home/user/root/mods/modx_install.xml', 
                    WEB_ROOT     => '/htdocs/phpbb3', 
                    STYLE        => 'prosilver',
                    LANG         => 'en',
                    OPERATION    => 'INSTALL',
                    );

DESCRIPTION ^

The installer will read the installation modx XML file which contains the instructions used to install the mod. It will process copy, sql and open instructions.

When called, the directory the calling script is located in will have a logs and a backup directory created. Any files overwritten or edited will be copied to the backups directory first. The logs directory will contain a debug, autit and error log which will contain details of what has happened.

EXPORT

install_phpbb_mod

This routine will control the installation of the mod. It accepts a hash as input. The following values can be passed in. INSTALL_FILE - The modx XML file. WEB_ROOT - The directory that phpbb is installed in. STYLE - Optional. The style that any updates should be applied to. Defaults to the board default. LANG - Optional. The language to be used. Defaults to the board default. OPERATION - Optional. Can be 'INSTALL' or 'UNINSTALL', default 'INSTALL'.

uninstall_phpbb_mod

NOT YET IMPLEMENTED This routine will uninstall the mod. The parameters are the same as above but OPERATION is ignored and is always set to 'UNINSTALL'.

SEE ALSO ^

Further information can be found at http://www.abc-rallying.co.uk/perl

AUTHOR ^

Ian Clark <perl@abc-rallying.co.uk>

LICENSE AND COPYRIGHT ^

Copyright (C) 2008 Ian Clark

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: