Admin Module example

[kovijanny]

Hi,

I have started to review this project and so far my experience is pleasant.
However, I need some help in creating a custom "Admin Module".
I have initial attempts but unfortunately it doesn't want to work.
My request/question would be if you could create a tutorial library without any extras.
Controller, Model and menu item I think would be sufficient,
with exampled Autoload and Route settings.
Thank you very much!

[lonnieezell]

Hey @kovijanny, I don't have any blank examples currently, and am in the middle of a refactor, but if you want examples of Admin Modules - all of Bonfire is one :) Check out the Modules folder. The only thing I think you would need to keep in mind is that Bonfire auto-inserts all of its namespaces, so for yours make sure you add a namespace to app/Config/Autoload.php for your new module.

[kovijanny]

Hi,

Thank You the answer!
Yes, I check it the Bonfire modules folder, but my probably is not working. :(
I use the app/Config/Autoload.php, but my Module.php (menu entry) not loaded...
I must be doing something wrong so a blank example would be nice.
When the time is right, please make one. (Please... :) )
Thank you very much...

[kovijanny]

Hi Lonnie,

I created the staruktura as described in the 'app/Modules'.

app/Modules/Blog/
Config/
Controllers/
Language/en
Libraries/
Models/
Views/
Modules.php

I added the new namespace for the $psr4 array in 'app/Config/Autoload.php',
'MyApp\Blog' => ROOTPATH . 'app/Modules/Blog',

I created the app/Modules/Blog/Config/Routes.php file with this content.

namespace MyApp\Blog\Config;

$routes->group(ADMIN_AREA, ['namespace' => 'MyApp\Blog\Controllers'], static function ($routes) {
$routes->get('blog', 'BlogController::index');
});

I created the app/Modules/Blog/Controller/BlogController.php file with this content.

namespace MyApp\Blog\Controllers;

use App\Controllers\AdminController;

class BlogController extends AdminController
{
protected $theme = 'Admin';
protected $viewPrefix = 'MyApp\Blog\Views\';

public function index()
{
    return $this->render($this->viewPrefix . 'welcome');
}

}

I created the app/Modules/Blog/Views/welcome.php file with this content.

<?php $this->extend('master') ?>

<?php $this->section('main') ?>

<x-page-head>

   `<x-module-title><i class="fab fa-blogger fa-lg"></i> <?=lang('Blog.Name')?></x-module-title>`

   `<h2><?=lang('Blog.Settings')?></h2>`

</x-page-head>

<x-admin-box>

    <b>WooooW</b>

</x-admin-box>

<?php $this->endSection() ?>

<?php $this->section('scripts') ?>

<script> </script>

<?php $this->endSection() ?>

I created the app/Modules/Blog/Module.php file with this content.

namespace MyApp\Blog;

use Bonfire\Config\BaseModule;
use Bonfire\Libraries\Menus\MenuItem;

class Module extends BaseModule
{
public function initAdmin()
{
$sidebar = service('menus');
$item = new MenuItem([
'title' => lang('Blog.Name'),
'namedRoute' => 'blog',
'fontAwesomeIcon' => 'fab fa-blogger fa-lg',
'permission' => '',
]);
$sidebar->menu('sidebar')->collection('content')->addItem($item);
}
}

The module works, but does not appear in the menu.
Please let me know what I did wrong that caused the module not to appear in the menu.
See the image

[joelprestaworks]

I would also love to see a skeleten module example since I'm having similar issues as above. I've tried with everything but can't manage to get my new module links to the sidebar as per the documentation describes.

[joelprestaworks]

After a bit of digging into the src I found out that recognition of custom modules does not work since Bonfire.php searches for modules within it's own structure, so creating a modules/ inside app/ won't work.

[lonnieezell]

Off the top of my head, two things:

1. Add the namespace to the Autoload config file. That should be all that it needs to find it. You're right that currently it won't auto-detect modules outside of Bonfire's own. You can check the namespace installed correctly with:

php spark namespaces

2. When adding the menu item, as described here, you must ensure that the namedRoute setting matches a named route in your module. Something like:

// Routes file:
$routes->get('recycler', 'RecycleController::viewResource', ['as' => 'recycler']);

// Menu configuration: 
$sidebar = service('menus');
$item    = new MenuItem([
    'title'           => 'Recycler',
    'namedRoute'      => 'recycler',                      <- THIS MUST MATCH THE `as` SPECIFIED IN THE ROUTE
    'fontAwesomeIcon' => 'fas fa-recycle',
    'permission'      => 'recycler.view',
]);
$sidebar->menu('sidebar')->collection('tools')->addItem($item);

[vachzar]

the problem is custom modules' file module.php outside Bonfire wasn't loaded by anything, so initAdmin() won't be executed to add the menu

[RasmusJDK]

I have spent the entire day trying to figure this out.

Did you find a way to trig the "initAdmin" function automatically?

[lonnieezell]

Since the refactor Bonfire wasn't discovering the modules. I just added the code for that and updated the docs. Please let me know if it works for you now.

[dgvirtual]

I have created a drop-in Admin module Pages with install instructions here:

https://github.com/dgvirtual/bonfire2-pages-module

The README file explains the installation steps. Detection of modules in app/Modules is still incomplete.

[dgvirtual]

@lonnieezell maybe you shouldn't delete the part of the docs "module must have its namespace registered manually. This is done in app/Config/Autoload.php .... " because we still need the modules to be autoloaded by Codeigniter.

Unless @lonnieezell has a patch in progress for this issue, I will submit a PR explaining how to have module namespace registered manually. Language files and Routes are not discovered otherwise.

[lonnieezell]

Modules located within App/Modules should be loaded here.

[dgvirtual]

Modules located within App/Modules should be loaded here.

And they are loaded there. If I do dd($this->moduleConfigs); at the end of discoverAppModules() method, I do get an element of array 'App\Modules\Pages' => 'App\Modules\Pages\Module', same as I get all the native Bonfire modules.

But, unless I add

'App\Modules\Pages' => APPPATH . 'Modules/Pages',

to app/Config/Autoload.php $psr4 property, the routes for my Pages module are not discovered by CI, and the files in Language dir do not get loaded as well. Here are the routes after adding the array value to $psr4:

and the first four lines are gone after I remove the App\Modules\Pages from $psr4 array.

How do I find out where the things do not work?

Actually, I see the \Bonfire* namespaces are defined before the src/Bonfire.php file is processed. I can add at the start of the boot() method a line

$aaa = new \Bonfire\Auth\Config\Auth(); dd($aaa);

and the contents of the object are dumped fine, no errors.

[dgvirtual]

OK, so I have found the problem and submitted a PR with solution. See #332