Q - How to install and setup phpBB3 custom extension ?

[Raja Pdl]

Version: phpBB 3.3

I've created a phpBB3 extension zip according to phpBB3 structure
Extension includes folders such as
acp, adm, config, controller, event, language, migrations, composer.json, ext.php

And I extract the zip file in phpbb3_project_directory/ext

But extension is not showing in ACP > Customize > Manage Extension

in phpBB3/ext/mindphp/m_testing/composer.json

โค้ด: เลือกทั้งหมด

{
    "name": "mindphp/m_testing",
    "description": "Example extension for phpBB 3.3",
    "version": "1.0.0",
    "type": "phpbb-extension",
    "require": {
        "php": ">=7.1"
    }
}

in phpBB3/ext/mindphp/m_testing/ext.php

โค้ด: เลือกทั้งหมด

<?php
namespace mindphp\m_testing;

class ext extends \phpbb\extension\base
{
    // This controls enabling or disabling the extension.
}

What steps needed to install a custom phpBB3 extension and how to fix it ?

[MindPHP Assistant]

To install a custom phpBB 3.3 extension and troubleshoot why it might not be appearing in the ACP, follow these steps:

### Structure Verification
1. **Check Extension Structure:**
Ensure your directory structure is correct. For phpBB extensions, it should be like this:

โค้ด: เลือกทั้งหมด

   phpbb3_project_directory/
   ├── ext/
   │   └── mindphp/
   │       └── m_testing/
   │           ├── acp/
   │           ├── adm/
   │           ├── config/
   │           ├── controller/
   │           ├── event/
   │           ├── language/
   │           ├── migrations/
   │           ├── composer.json
   │           └── ext.php
   

### File and Class Verification
2. **Check `composer.json`:**
Ensure your `composer.json` is formatted correctly. The arrow `>` should be `>`.

โค้ด: เลือกทั้งหมด

json
   {
       "name": "mindphp/m_testing",
       "description": "Example extension for phpBB 3.3",
       "version": "1.0.0",
       "type": "phpbb-extension",
       "require": {
           "php": ">=7.1"
       }
   }
   

3. **Check `ext.php`:**
Confirm that your `ext.php` file is correctly set up. Your namespace and class should match exactly the directory structure and naming conventions:

โค้ด: เลือกทั้งหมด

php
   <?php
   namespace mindphp\m_testing;

   class ext extends \phpbb\extension\base
   {
       // This controls enabling or disabling the extension.
   }
   

### Troubleshooting Steps
4. **Clear Board Cache:**
After ensuring the structure and files are correct, clear the phpBB cache. You can do this via the ACP under "General" -> "Purge the cache" or manually by deleting all files (except .htaccess and index.htm) in the `cache/` directory.

5. **Check File Permissions:**
Make sure that the `ext/mindphp/m_testing` directory and its files have the correct permissions so that the web server can read them. Typically, directories should have `755` and files `644`.

6. **Verify Extension Name in ACP:**
Sometimes it takes a moment for the changes to reflect. Refresh the "Customize" -> "Manage extensions" page in the ACP.

7. **PHP and Server Errors:**
Check your server's error logs and the phpBB error logs for any error messages that might indicate why the extension is not being recognized.

8. **Double-Check PHP Version:**
Ensure that your server is running PHP 7.1 or higher since your extension requires that.

### Final Steps
If everything is set up correctly and you still don't see the extension, try renaming the `composer.json` or `ext.php` to force a refresh, and then rename them back. After this, clear the cache again and try accessing the ACP.

By following these steps, you should be able to identify any issues preventing your extension from appearing in the phpBB ACP.

[Raja Pdl]

I've tested the structure and codes. But it is not working

[Raja Pdl]

There are some code entries missing in the composer.json file. When I compare it with other projects, I see that I need to add the extension name under 'extra' in the composer.json file.

โค้ด: เลือกทั้งหมด

"extra": {
        "display-name": "Extension Name",
        "soft-require": {
            "phpbb/phpbb": ">=3.1.0"
        }
    }

By adding this code, 'Extension Name' will appear in ACP > Customize > Manage Extensions.

Thank you very much