/phpbb-ext-skeleton

A skeleton extension generator
  1. HTML 59.4%
  2. PHP 38.8%
  3. JavaScript 1.1%
  4. Other 0.7%
HTML PHP JavaScript Other
Find file
Latest commit c87eee1 Aug 5, 2016 @VSEphpbb VSEphpbb committed on GitHub Merge pull request #45 from VSEphpbb/updates 
Fix readme & docblock
Permalink
Failed to load latest commit information.
config Add extra files to components that may need them Jul 9, 2016
console Replace deprecated console helper Apr 4, 2016
controller Use aarray key exists instead of isset. It's what we're really testin… Jun 16, 2016
event Code housekeeping Mar 30, 2016
helper Further simplify 3.2.x template instantiation Jul 24, 2016
language/en Instead of validating author, always create author JSON Apr 27, 2016
skeleton Add independent 3.1 and 3.2 branch version enable checks Jul 22, 2016
styles/prosilver Cache jquery selectors May 2, 2016
.gitignore Add phing and build script Mar 31, 2016
README.md Update README Aug 5, 2016
build.xml Update build scripts May 30, 2016
composer.json Bump version Aug 5, 2016
composer.lock Update composer.lock file Apr 4, 2016
composer.phar Add phing and build script Mar 31, 2016
ext.php Fix bad docblock Aug 5, 2016
license.txt Init commit May 29, 2015
skeleton.php Extract the logic so we can reuse it on a controller May 29, 2015

README.md

phpBB Skeleton Extension

phpBB's Skeleton Extension is a tool for extension authors to help speed up and simplify the task of starting a new extension project. It generates sample starter files and directories in a skeleton package that you can use to begin building your extension.

Requirements

  • phpBB version 3.1.4 or later (also compatible with phpBB 3.2.0-b3 or newer).
  • PHP version 5.3.3 or later.
  • PHP module ZipArchive enabled.

Installation

  • Ensure your phpBB and PHP installations meet the Skeleton Extension requirements.
  • Download the latest release.
  • Unzip and install to your phpBB ext/ folder
  • Go to "ACP" > "Customise" > "Extensions" and enable the "phpBB Skeleton Extension" extension.

Contributing

To install the source code from this repository, clone the contents of this repository to phpBB/ext/phpbb/skeleton, then run Composer from the extension's directory:

$ php composer.phar install

Create an Extension Skeleton

Web-based user interface

In order to create an extension via the web UI just open your local development board and visit the "Create skeleton extension" link in the forum's navigation bar:

https://localhost/phpBB/app.php/skeleton

A packaged ZIP file is then offered as a download. Additionally it can be found in store/tmp-ext/.

Command line interface

In order to create an extension via the CLI, you need to open the console of your server. Then run the following command in your phpBB root (next to config.php):

$ ./bin/phpbbcli.php extension:create

A packaged ZIP file can be found in store/tmp-ext/.

License

GPLv2