Q - How to fix yaml file error in phpBB3 custom extension ?

[Raja Pdl]

I've (1) created phpBB 3 extension named "m_example",
(2) extract in "ext" folder
(3) Go to ACP > Customize and click on "Enable"
(4) After that, if I go to any page of the board, it displays the following error

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

Fatal error: Uncaught InvalidArgumentException: The definition of "m_example_main" in "C:\xampp\htdocs\phpbb_3\ext/mindphp/m_example/config/routing.yml" must be a YAML array. in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php:203 Stack trace: #0 C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php(88): Symfony\Component\Routing\Loader\YamlFileLoader->validate(NULL, 'm_example_main', 'C:\\xampp\\htdocs...') #1 C:\xampp\htdocs\phpbb_3\vendor\symfony\config\Loader\DelegatingLoader.php(40): Symfony\Component\Routing\Loader\YamlFileLoader->load('ext/mindphp/m_e...', 'yaml') #2 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(116): Symfony\Component\Config\Loader\DelegatingLoader->load('ext/mindphp/m_e...', 'yaml') #3 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(261): phpbb\routing\router->get_routes() #4 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(246): phpbb\routing\router->create_dumped_url_generator() #5 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(168): phpbb\routing\router->get_generator() #6 C:\xampp\htdocs\phpbb_3\phpbb\routing\helper.php(148): phpbb\routing\router->generate('phpbb_help_faq_...', Array, 1) #7 C:\xampp\htdocs\phpbb_3\phpbb\controller\helper.php(212): phpbb\routing\helper->route('phpbb_help_faq_...', Array, true, false, 1) #8 C:\xampp\htdocs\phpbb_3\includes\functions.php(4050): phpbb\controller\helper->route('phpbb_help_faq_...') #9 C:\xampp\htdocs\phpbb_3\tools_resistor_calculator.php(688): page_header('Resistor Color ...', false) #10 {main} thrown in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php on line 203

Screenshot:

Screenshot (2165).png (120 KiB) Viewed 713 times

The generated "routing.yml" file code is
"phpbb_3\ext\mindphp\m_example\config\routing.yml"

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

m_example_main:
path: /mextension
defaults: { _controller: mindphp.m_example.controller.main_controller }

How can I fix it ?

version - phpBB 3

[eange08]

You should change mindphp.m_example.controller.main_controller to mindphp.m_example.controller:main_controller to match the syntax expected by phpBB.

So, your routing.yml file should look like this:

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

m_example_main:
  path: /mextension
  defaults: 
    _controller: mindphp.m_example.controller:main_controller

After making this change, remember to clear phpBB's cache and try enabling the extension again.

[eange08]

You can check the structure of each file in the phpBB extension at: https://area51.phpbb.com/docs/dev/maste ... ml#routing


It's recommended that the path name should match the controller name, for example:

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

m_example_main:
  path: /m_example_main
  defaults: 
    _controller: mindphp.m_example.controller:main_controller

This helps maintain consistency and makes it easier to understand the file structure.

[eange08]

You can check the structure of each file in the phpBB extension at: https://area51.phpbb.com/docs/dev/maste ... ml#routing


It's recommended that the path name should match the controller name, for example:

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

m_example_main:
  path: /m_example_main
  defaults: 
    _controller: mindphp.m_example.controller:main_controller

This helps maintain consistency and makes it easier to understand the file structure.

[Raja Pdl]

I changed the codes as following and diabled and enabled again, clear the cache, but it displays the same error

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

m_example_main:
path: /m_example_main
defaults: 
  _controller: mindphp.m_example.controller:main_controller

I also tested like
from this structure link - https://area51.phpbb.com/docs/dev/maste ... ml#routing

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

m_example_main:
path: /m_example_main
defaults: { _controller:mindphp.m_example.controller:handle }

But it displays the same error
What can I do now ?

[eange08]

It seems your information is too limited. Here's a checklist to troubleshoot:

1. **What error message appears?**
2. **Check the controller file**: Does it contain a method named `main_controller`?
3. **Verify the services file**: Make sure it correctly references the controller path.

Sample setup for `services`:
```yaml

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

   
   services:
       mindphp.m_example.controller:
           class: mindphp\m_example\controller\main  # Ensure this matches the controller file name
           arguments:
               - '@config'
               - '@controller.helper'
               - '@language'
               - '@template'
   ```

Confirm each point to help locate any misconfiguration.

[Raja Pdl]

(1) Error Message is

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

Fatal error: Uncaught InvalidArgumentException: The definition of "m_example_main" in "C:\xampp\htdocs\phpbb_3\ext/mindphp/m_example/config/routing.yml" must be a YAML array. in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php:203 Stack trace: #0 C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php(88): Symfony\Component\Routing\Loader\YamlFileLoader->validate(NULL, 'm_example_main', 'C:\\xampp\\htdocs...') #1 C:\xampp\htdocs\phpbb_3\vendor\symfony\config\Loader\DelegatingLoader.php(40): Symfony\Component\Routing\Loader\YamlFileLoader->load('ext/mindphp/m_e...', 'yaml') #2 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(116): Symfony\Component\Config\Loader\DelegatingLoader->load('ext/mindphp/m_e...', 'yaml') #3 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(261): phpbb\routing\router->get_routes() #4 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(246): phpbb\routing\router->create_dumped_url_generator() #5 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(168): phpbb\routing\router->get_generator() #6 C:\xampp\htdocs\phpbb_3\phpbb\routing\helper.php(148): phpbb\routing\router->generate('phpbb_help_faq_...', Array, 1) #7 C:\xampp\htdocs\phpbb_3\phpbb\controller\helper.php(212): phpbb\routing\helper->route('phpbb_help_faq_...', Array, true, false, 1) #8 C:\xampp\htdocs\phpbb_3\includes\functions.php(4050): phpbb\controller\helper->route('phpbb_help_faq_...') #9 C:\xampp\htdocs\phpbb_3\aboutus.php(10): page_header('Title Here') #10 {main} thrown in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php on line 203

(2)The controller file "mindphp/m_example/controller/main.php" file doesn't include "main_controller" method,
it includes only handle() method

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

<?php
namespace mindphp\m_example\controller;

class main
{
    public function handle()
    {
        return 'Hello from m_example!';
    }
}

So, I changed method name to "handle" in routing.yml,

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

m_example_main:
path: /m_example_main
defaults: 
  _controller: mindphp.m_example.controller:handle

But it displays the same error

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

Fatal error: Uncaught InvalidArgumentException: The definition of "m_example_main" in "C:\xampp\htdocs\phpbb_3\ext/mindphp/m_example/config/routing.yml" must be a YAML array. in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php:203 Stack trace: #0 C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php(88): Symfony\Component\Routing\Loader\YamlFileLoader->validate(NULL, 'm_example_main', 'C:\\xampp\\htdocs...') #1 C:\xampp\htdocs\phpbb_3\vendor\symfony\config\Loader\DelegatingLoader.php(40): Symfony\Component\Routing\Loader\YamlFileLoader->load('ext/mindphp/m_e...', 'yaml') #2 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(116): Symfony\Component\Config\Loader\DelegatingLoader->load('ext/mindphp/m_e...', 'yaml') #3 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(261): phpbb\routing\router->get_routes() #4 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(246): phpbb\routing\router->create_dumped_url_generator() #5 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(168): phpbb\routing\router->get_generator() #6 C:\xampp\htdocs\phpbb_3\phpbb\routing\helper.php(148): phpbb\routing\router->generate('phpbb_help_faq_...', Array, 1) #7 C:\xampp\htdocs\phpbb_3\phpbb\controller\helper.php(212): phpbb\routing\helper->route('phpbb_help_faq_...', Array, true, false, 1) #8 C:\xampp\htdocs\phpbb_3\includes\functions.php(4050): phpbb\controller\helper->route('phpbb_help_faq_...') #9 C:\xampp\htdocs\phpbb_3\aboutus.php(10): page_header('Title Here') #10 {main} thrown in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php on line 203

(3) When I generate extension, services.yml file is empty

When I add the following codes in services.yml

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

 services:
     mindphp.m_example.controller:
         class: mindphp\m_example\controller\main 
         arguments:
             - '@config'
             - '@controller.helper'
             - '@language'
             - '@template'
 ```

it displays the following error

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

phpBB encountered an error building the container due to an installed extension. For this reason, all extensions have been temporarily disabled. Please try purging your forum cache. All extensions will automatically be re-enabled once the container error is resolved. If this error continues, please visit phpBB.com for support.


Exception: The file "C:\xampp\htdocs\phpbb_3\ext\mindphp\m_example\config\services.yml" does not contain valid YAML: Unable to parse in "C:\\xampp\\htdocs\\phpbb_3\\ext\\mindphp\\m_example\\config\\services.yml" at line 1 (near " services:").

#0 C:\xampp\htdocs\phpbb_3\vendor\symfony\dependency-injection\Loader\YamlFileLoader.php(117): Symfony\Component\DependencyInjection\Loader\YamlFileLoader->loadFile('C:\\xampp\\htdocs...')
#1 C:\xampp\htdocs\phpbb_3\phpbb\extension\di\extension_base.php(99): Symfony\Component\DependencyInjection\Loader\YamlFileLoader->load('services.yml')
#2 C:\xampp\htdocs\phpbb_3\phpbb\extension\di\extension_base.php(63): phpbb\extension\di\extension_base->load_services(Object(Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationContainerBuilder))
#3 C:\xampp\htdocs\phpbb_3\vendor\symfony\dependency-injection\Compiler\MergeExtensionConfigurationPass.php(71): phpbb\extension\di\extension_base->load(Array, Object(Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationContainerBuilder))
#4 C:\xampp\htdocs\phpbb_3\vendor\symfony\http-kernel\DependencyInjection\MergeExtensionConfigurationPass.php(39): Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationPass->process(Object(Symfony\Component\DependencyInjection\ContainerBuilder))
#5 C:\xampp\htdocs\phpbb_3\vendor\symfony\dependency-injection\Compiler\Compiler.php(140): Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass->process(Object(Symfony\Component\DependencyInjection\ContainerBuilder))
#6 C:\xampp\htdocs\phpbb_3\vendor\symfony\dependency-injection\ContainerBuilder.php(789): Symfony\Component\DependencyInjection\Compiler\Compiler->compile(Object(Symfony\Component\DependencyInjection\ContainerBuilder))
#7 C:\xampp\htdocs\phpbb_3\phpbb\di\container_builder.php(223): Symfony\Component\DependencyInjection\ContainerBuilder->compile()
#8 C:\xampp\htdocs\phpbb_3\common.php(115): phpbb\di\container_builder->get_container()
#9 C:\xampp\htdocs\phpbb_3\adm\index.php(23): require('C:\\xampp\\htdocs...')
#10 {main}

Screenshot (2175).png (265.79 KiB) Viewed 688 times

[eange08]

Here's the response in English:

The `services.yml` file and the PHP file you provided seem correct in terms of YAML structure and PHP class setup. However, the YAML error may be due to incorrect indentation or formatting issues in the `services.yml` file. To avoid the error, try the following adjustments:

1. **Correct `services.yml` Formatting:** Ensure proper YAML syntax with the following structure:

```yaml

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

  services:
       mindphp.m_example.controller:
           class: mindphp\m_example\controller\main
           arguments:
               - '@config'
               - '@controller.helper'
               - '@language'
               - '@template'

2. **Spacing and Indentation:**
- Make sure `services:` starts at the beginning of the line without any spaces in front.
- Use 4 spaces for indentation under `mindphp.m_example.controller` to correctly define the `class` and `arguments`.

3. **Clear the Cache:** After making these adjustments, clear the phpBB cache by going to `ACP > General > Purge the cache`. Alternatively, navigate to the `cache` folder in phpBB and delete all files except for `.htaccess` to force phpBB to reload the updated files.

4. **Check File Structure:** Verify that your folder and file structure are correct:
- `ext/mindphp/m_example/config/services.yml`
- `ext/mindphp/m_example/controller/main.php`

5. **Test Again:** After clearing the cache and verifying the structure, try enabling the extension once more to see if the issue is resolved.

[Raja Pdl]

Here's the response in English:

The `services.yml` file and the PHP file you provided seem correct in terms of YAML structure and PHP class setup. However, the YAML error may be due to incorrect indentation or formatting issues in the `services.yml` file. To avoid the error, try the following adjustments:

1. **Correct `services.yml` Formatting:** Ensure proper YAML syntax with the following structure:

```yaml

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

  services:
       mindphp.m_example.controller:
           class: mindphp\m_example\controller\main
           arguments:
               - '@config'
               - '@controller.helper'
               - '@language'
               - '@template'

2. **Spacing and Indentation:**
- Make sure `services:` starts at the beginning of the line without any spaces in front.
- Use 4 spaces for indentation under `mindphp.m_example.controller` to correctly define the `class` and `arguments`.

3. **Clear the Cache:** After making these adjustments, clear the phpBB cache by going to `ACP > General > Purge the cache`. Alternatively, navigate to the `cache` folder in phpBB and delete all files except for `.htaccess` to force phpBB to reload the updated files.

4. **Check File Structure:** Verify that your folder and file structure are correct:
- `ext/mindphp/m_example/config/services.yml`
- `ext/mindphp/m_example/controller/main.php`

5. **Test Again:** After clearing the cache and verifying the structure, try enabling the extension once more to see if the issue is resolved.

By following these steps, the error displaying for services.yml has removed

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

services:
 mindphp.m_example.controller:
     class: mindphp\m_example\controller\main
     arguments:
         - '@config'
         - '@controller.helper'
         - '@language'
         - '@template'

But the error for routing.yml is not solved

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

m_example_main:
path: /m_example_main
defaults: 
  _controller: mindphp.m_example.controller:handle

it displays the same error

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

Fatal error: Uncaught InvalidArgumentException: The definition of "m_example_main" in "C:\xampp\htdocs\phpbb_3\ext/mindphp/m_example/config/routing.yml" must be a YAML array. in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php:203 Stack trace: #0 C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php(88): Symfony\Component\Routing\Loader\YamlFileLoader->validate(NULL, 'm_example_main', 'C:\\xampp\\htdocs...') #1 C:\xampp\htdocs\phpbb_3\vendor\symfony\config\Loader\DelegatingLoader.php(40): Symfony\Component\Routing\Loader\YamlFileLoader->load('ext/mindphp/m_e...', 'yaml') #2 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(116): Symfony\Component\Config\Loader\DelegatingLoader->load('ext/mindphp/m_e...', 'yaml') #3 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(261): phpbb\routing\router->get_routes() #4 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(246): phpbb\routing\router->create_dumped_url_generator() #5 C:\xampp\htdocs\phpbb_3\phpbb\routing\router.php(168): phpbb\routing\router->get_generator() #6 C:\xampp\htdocs\phpbb_3\phpbb\routing\helper.php(148): phpbb\routing\router->generate('phpbb_help_faq_...', Array, 1) #7 C:\xampp\htdocs\phpbb_3\phpbb\controller\helper.php(212): phpbb\routing\helper->route('phpbb_help_faq_...', Array, true, false, 1) #8 C:\xampp\htdocs\phpbb_3\includes\functions.php(4050): phpbb\controller\helper->route('phpbb_help_faq_...') #9 C:\xampp\htdocs\phpbb_3\aboutus.php(10): page_header('Title Here') #10 {main} thrown in C:\xampp\htdocs\phpbb_3\vendor\symfony\routing\Loader\YamlFileLoader.php on line 203

mindphp/m_example/controller/main.php

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

<?php
namespace mindphp\m_example\controller;

class main
{
    public function handle()
    {
        return 'Hello from m_example!';
    }
}

[eange08]

Based on the properties you've decided to use in the controller, we can adjust the `services.yml` and the `controller` to align with this setup:

### `services.yml`

In `services.yml`, specify only the `arguments` that match the properties in the controller's constructor, removing any unnecessary arguments:

```yaml

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

services:
  mindphp.m_example.controller:
    class: mindphp\m_example\controller\main
    arguments:
      - '@config'
      - '@cache'
      - '@dbal.conn'
      - '@template'
      - '@user'
      - '@controller.helper'
      - '@service_container'
      - '@request'
      - '@auth'
      - '%core.table_prefix%'

### `controller/main.php`

Update the controller to use only the needed properties:

```php

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

<?php
namespace mindphp\m_example\controller;

class main
{
    protected $config;
    protected $cache;
    protected $db;
    protected $template;
    protected $user;
    protected $helper;
    protected $phpbb_container;
    protected $request;
    protected $auth;
    protected $table_prefix;

    public function __construct(\phpbb\config\config $config, \phpbb\cache\service $cache, \phpbb\db\driver\driver_interface $db, \phpbb\template\template $template, \phpbb\user $user, \phpbb\controller\helper $helper, Container $phpbb_container, \phpbb\request\request $request, \phpbb\auth\auth $auth, $table_prefix) {
        $this->config = $config;
        $this->cache = $cache;
        $this->db = $db;
        $this->template = $template;
        $this->user = $user;
        $this->helper = $helper;
        $this->phpbb_container = $phpbb_container;
        $this->request = $request;
        $this->auth = $auth;
        $this->table_prefix = $table_prefix;
    }

    public function handle()
    {
        // Assign a greeting to the template for testing
        $this->template->assign_vars([
            'GREETING' => 'Hello from m_example!',
        ]);

        return $this->helper->render('m_example_template.html');
    }
}

### Summary

- **`services.yml`**: Only include the arguments specified in the constructor.
- **`controller/main.php`**: Keep only the properties that are actively used.