phpbb / phpbb-ext-acme-demo

ACME Demo Extension for phpBB: http://en.wikipedia.org/wiki/Acme_Corporation

phpBB is a free open-source bulletin board written in PHP.

🧑🏻‍🤝🏻🧑🏽 Community

Get your copy of phpBB, find support and lots more on phpBB.com. Discuss the development on area51.

👨‍💻 Contribute

1. Create an account on phpBB.com
2. Create a ticket (unless there already is one)
3. Read our Coding guidelines and Git Contribution Guidelines
4. Send us a pull request

🏗️ Setting up a development build of phpBB

To run an installation from the repo (and not from a pre-built package) on a local server, run the following commands:

• Fork phpbb/phpbb to your GitHub account, then create a local clone of it:

  git clone https://github.com/your_github_name/phpbb.git
  

• Install phpBB's dependencies (from the root of your phpbb repo):

  cd phpBB
  php ../composer.phar install
  

Alternatively, you can read:

• Our Vagrant documentation to find out how to use Vagrant to develop and contribute to phpBB.
• Our GitHub Codespaces documentation to learn about phpBB's cloud-based development environment.

📓 Documentation

phpBB's Development Documentation contains all the information you'll need to learn about developing for phpBB's core, extensions and automated testing.

🔬 Automated Testing

We have unit and functional tests in order to prevent regressions. You can view the bamboo continuous integration here or check our GitHub Actions below:

Branch	Description	GitHub Actions
master	Latest development version
3.3.x	Development of version 3.3.x

📜 License

GNU General Public License v2

phpbb-ext-acme-demo's Issues

JSON_PRETTY_PRINT Option in db_test_case

In database test case:

If (version_compare(PHP_VERSION, '5.4.0', '>='))
{
    fwrite($fp, json_encode($schema_data, JSON_PRETTY_PRINT));
}
else
{
    fwrite($fp, json_encode($schema_data));
}

Although, if the visual appearance of the json schema file is unimportant, since its just created for testing, then perhaps the JSON_PRETTY_PRINT option isn't necessary at all here.

phpunit errors

hi,

i ran the phpunit tests, could you have a look at these results please ?

zeus:phpbb31 Nix$ phpBB/vendor/bin/phpunit -c phpBB/ext/acme/demo/phpunit.xml.dist
PHPUnit 4.1.0 by Sebastian Bergmann.

Configuration read from /Users/Nix/Sites/phpbb31/phpBB/ext/acme/demo/phpunit.xml.dist

.
Warning: copy(/Users/Nix/Sites/phpbb31/tests/test_framework/../../phpBB/install/schemas/schema.json): failed to open stream: No such file or directory in /Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_database_test_case.php on line 85

Warning: copy(/Users/Nix/Sites/phpbb31/tests/test_framework/../../phpBB/install/schemas/schema.json): failed to open stream: No such file or directory in /Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_database_test_case.php on line 86
E
Warning: copy(/Users/Nix/Sites/phpbb31/tests/test_framework/../tmp/schema_phpbb_copy.json): failed to open stream: No such file or directory in /Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_database_test_case.php on line 96
EE

Time: 98 ms, Memory: 9.00Mb

There were 3 errors:

1) acme\demo\tests\dbal\simple_test::test_column
RuntimeException: You have specified an invalid dbms driver: 

/Users/Nix/Sites/phpbb31/phpBB/phpbb/config_php_file.php:173
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_test_case_helpers.php:153
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_database_test_case.php:164
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_database_test_case.php:176
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_database_test_case.php:119

2) acme\demo\tests\functional\demo_test
RuntimeException: You have specified an invalid dbms driver: 

/Users/Nix/Sites/phpbb31/phpBB/phpbb/config_php_file.php:173
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_test_case_helpers.php:153
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_functional_test_case.php:43

3) acme\demo\tests\functional\demo_test
RuntimeException: You have specified an invalid dbms driver: 

/Users/Nix/Sites/phpbb31/phpBB/phpbb/config_php_file.php:173
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_test_case_helpers.php:153
/Users/Nix/Sites/phpbb31/tests/test_framework/phpbb_functional_test_case.php:43

FAILURES!                          
Tests: 2, Assertions: 3, Errors: 3.
zeus:phpbb31 Nix$ 

Some name changes

Can you change the test suite names in the travis xml files (so it's less for us to change when moving to our extensions)?

<testsuite name="Acme Demo Test Suite">
<testsuite name="Acme Demo Functional Tests">

Replace Acme Demo with Extension
It's more generic that way :)

Don't set branch limits in travis

Should the branches - only section in travis.yml be removed?

Support adding extension lang files in functional tests

Add to functional_test_case.php

protected function add_lang_ext($lang_file)
{
    if (is_array($lang_file))
    {
        foreach ($lang_file as $file)
        {
            $this->add_lang_ext($file);
        }

        return;
    }

    $lang_path = __DIR__ . "/../../language/en/$lang_file.php";

    $lang = array();

    if (file_exists($lang_path))
    {
        include($lang_path);
    }

    $this->lang = array_merge($this->lang, $lang);
}

How to avoid using global variables in the acp module

This example module depend on global variables in acp/main_module.php. Is it a 'true way'? I know how DI works in controllers and events. How can I correctly use DI in my ACP modules too?

Rogue `s` character

extraneous s character in this file:

<exclude>phpBB/ext/acme/demo/tests/functional/</exclude>s <-- s at end??

https://github.com/nickvergessen/phpbb-ext-acme-demo/blob/master/travis/phpunit-postgres-travis.xml#L17

Composer Failures

I managed to find a way around the fails of the composer install.

It appears to be related to caching and APC.

I disabled the APC before composer installs, then re-enabled it after, in travis.yml, like so

  - echo "apc.enable_cli=0" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
  - php ../composer.phar install --dev --no-interaction --prefer-source
  - echo "apc.enable_cli=1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini

See it worked (well, except for hhvm):
https://travis-ci.org/VSEphpbb/boardrules/builds/23698741

Maybe you can come up with a better solution, but this shows we're on track

UCP / MCP Modules

Can you add quick and simple UCP and MCP modules too, just as examples? I could do it in a PR if you want, but I think there should be examples of this as well.