Part of the LM-Commons series of community developed packages for Laminas
array(
+ 'admin' => array(
+ 'my-module' => array(
+ 'label' => 'My Module',
+ 'route' => 'lmcadmin/foo/bar',
+ ),
+ ),
+ ),
+```
+
+The navigation in LmcAdmin uses `Laminas\Navigation` and more information about the configuration of this component is located in the [Laminas Mvc Framework](https://docs.laminas.dev/laminas-navigation/quick-start/) reference guide.
diff --git a/docs/versioned_docs/version-1.2/Routes.md b/docs/versioned_docs/version-1.2/Routes.md
new file mode 100644
index 0000000..d1c2719
--- /dev/null
+++ b/docs/versioned_docs/version-1.2/Routes.md
@@ -0,0 +1,61 @@
+---
+sidebar_position: 2
+---
+# Routes
+LmcAdmin enables a single route named `lmcadmin`, which is a literal route and standard using the url `/admin`. You can create child routes under `lmcadmin` so you enable urls like `/admin/foo` or `/admin/bar/baz`.
+
+## Add child route
+To register a route as child route, the following example takes the option you name that route `foo`. The complete path should look like `/admin/foo`, so `foo` is a literal route with the route value `/foo`. Say you want this route to connect to your `MyModule\Controller\MyController` controller and the `index` action, create this config in your `module.config.php`:
+
+```php
+ 'router' => array(
+ 'routes' => array(
+ 'lmcadmin' => array(
+ 'child_routes' => array(
+ 'foo' => array(
+ 'type' => 'literal',
+ 'options' => array(
+ 'route' => '/foo',
+ 'defaults' => array(
+ 'controller' => 'MyModule\Controller\MyController',
+ 'action' => 'index',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+```
+
+## Change the `/admin` url
+If you want your admin interface at `/backend` or something else, you must override the value of the route. In the following config, the `/admin` route value is replaced with `/backend`. Make sure this is enabled in a config where the module is registered *later* than LmcAdmin (otherwise, the config will not overwrite LmcAdmin's configuration):
+
+```php
+ 'router' => array(
+ 'routes' => array(
+ 'lmcadmin' => array(
+ 'options' => array(
+ 'route' => '/backend',
+ ),
+ ),
+ ),
+```
+
+## Change the controller behind `/admin`
+By default, the `/admin` url links to the `LmcAdmin\Controller\AdminController` controller. It's an empty action and a simple view script is rendered. If you want, for example, create a dashboard on the admin index page, you probably need to point the route to another controller. In the following config, the `lmcadmin` route's controller is replaced with `MyModule/Controller/AdminController` and the action is set to `dashboard`. Make sure this is enabled in a config where the module is registered *later* than LmcAdmin (otherwise, the config will not overwrite LmcAdmin's configuration):
+
+```php
+ 'router' => array(
+ 'routes' => array(
+ 'lmcadmin' => array(
+ 'options' => array(
+ 'defaults' => array(
+ 'controller' => 'MyModule/Controller/AdminController',
+ 'action' => 'dashboard',
+ ),
+ ),
+ ),
+ ),
+ ),
+```
diff --git a/docs/versioned_docs/version-1.2/ViewLayout.md b/docs/versioned_docs/version-1.2/ViewLayout.md
new file mode 100644
index 0000000..16de206
--- /dev/null
+++ b/docs/versioned_docs/version-1.2/ViewLayout.md
@@ -0,0 +1,65 @@
+---
+sidebar_position: 5
+title: View & Layout
+---
+# View and layout scripts
+LmcAdmin includes an admin layout and index view script, so LmcAdmin works out of the box. These view scripts are fully customizable, you can turn them off or render other scripts. All options are listed below.
+
+## Override admin layout
+You can define your own layout script. If you want a custom layout template, you must create a module where this layout is defined. Then the resolver can automatically find a version of the layout if you configure your module correctly. Say you have a module `MyAdmin`, create a module configuration to load view scripts for that module in the `module.config.php`:
+
+```php
+ 'view_manager' => array(
+ 'template_path_stack' => array(
+ __DIR__ . '/../view'
+ ),
+ ),
+```
+The MyAdmin module must contain a `view` directory. Inside this directory, create another directory called `layout` and inside `layout` create a file `admin.phtml`. So this file is located (if your MyAdmin module is under the `module/` directory of your application) at `module/MyAdmin/view/layout/admin.phtml`.
+
+Make sure MyAdmin is registered in the `application.config.php` and `LmcAdmin` is located *above* `MyAdmin`. Then your new admin template will be loaded.
+
+## Override admin index view script
+You can also define the script rendered when you visit `/admin`. The way to solve this is similar to changing the layout (see above), only the location of the view script is different. So create a new module, for example MyAdmin, and enable this configuration:
+
+```php
+ 'view_manager' => array(
+ 'template_path_stack' => array(
+ __DIR__ . '/../view'
+ ),
+ ),
+```
+Then create the folders `lmc-admin/admin` inside the `view` directory. Inside `lmc-admin/admin`, create an `index.phtml` file. So this file is located (if your MyAdmin module is under the `module/` directory of your application) at `module/MyAdmin/view/lmc-admin/admin/index.phtml`.
+
+Make sure MyAdmin is registered in the `application.config.php` and `LmcAdmin` is located *above* `MyAdmin`. Then your new index view script will be loaded.
+
+## Rename admin layout
+If you already have a `layout/admin` layout template and want to use another layout for LmcAdmin, you can rename the layout used. By default it is `layout/admin` but you can for example configure LmcAdmin to switch to `layout/backend`. You can enable this configuration to use another layout name:
+
+```php
+ 'lmcadmin' => array(
+ 'admin_layout_template' => 'layout/backend'
+ ),
+```
+
+## Disable layout
+If you need a page with a controller where only the view script is rendered, you can disable the layout. Layout disabling works just like any other page outside LmcAdmin where you disable the layout. To accomplish this, you must terminate the view model in the controller:
+
+```php
+ public function indexAction()
+ {
+ $model = new ViewModel;
+ $model->setTerminal(true);
+
+ return $model;
+ }
+```
+
+## Use normal `layout.phtml` layout
+You can disable LmcAdmin to switch to the `layout/admin` layout at all. The routing and navigation still works, but the name of the layout script is untouched. You can enable this configuration to disable layout switching:
+
+```php
+ 'lmcadmin' => array(
+ 'use_admin_layout' => false
+ ),
+```
diff --git a/docs/versioned_sidebars/version-1.2-sidebars.json b/docs/versioned_sidebars/version-1.2-sidebars.json
new file mode 100644
index 0000000..5f41a72
--- /dev/null
+++ b/docs/versioned_sidebars/version-1.2-sidebars.json
@@ -0,0 +1,8 @@
+{
+ "documentationSidebar": [
+ {
+ "type": "autogenerated",
+ "dirName": "."
+ }
+ ]
+}
diff --git a/docs/versions.json b/docs/versions.json
new file mode 100644
index 0000000..a869fac
--- /dev/null
+++ b/docs/versions.json
@@ -0,0 +1,3 @@
+[
+ "1.2"
+]
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
index a6100ef..d5259c4 100644
--- a/src/ConfigProvider.php
+++ b/src/ConfigProvider.php
@@ -9,9 +9,6 @@
use Lmc\Admin\Options\ModuleOptions;
use Lmc\Admin\Options\ModuleOptionsFactory;
-/**
- * Class ConfigProvider.
- */
class ConfigProvider
{
public function __invoke(): array
@@ -19,18 +16,18 @@ public function __invoke(): array
return [
'dependencies' => $this->getDependencyConfig(),
'view_manager' => $this->getViewManagerConfig(),
- 'lmc_admin' => $this->getModuleConfig(),
- 'controllers' => $this->getControllerConfig(),
- 'router' => $this->getRouterConfig(),
+ 'lmc_admin' => $this->getModuleConfig(),
+ 'controllers' => $this->getControllerConfig(),
+ 'router' => $this->getRouterConfig(),
];
}
-
+
public function getDependencyConfig(): array
{
return [
'factories' => [
- 'admin_navigation' => Navigation\Service\AdminNavigationFactory::class,
- ModuleOptions::class => ModuleOptionsFactory::class,
+ 'admin_navigation' => Navigation\Service\AdminNavigationFactory::class,
+ ModuleOptions::class => ModuleOptionsFactory::class,
LayoutTemplateSelectListener::class => LayoutTemplateSelectListenerFactory::class,
],
];
@@ -42,9 +39,9 @@ public function getViewManagerConfig(): array
'template_path_stack' => [
__DIR__ . '/../view',
],
- 'template_map' => [
+ 'template_map' => [
'lmc-admin/admin/index' => __DIR__ . '/../view/lmc/admin/index.phtml',
- 'layout/lmcadmin' => __DIR__ . '/../view/lmc/layout/admin.phtml',
+ 'layout/lmcadmin' => __DIR__ . '/../view/lmc/layout/admin.phtml',
],
];
}
@@ -82,12 +79,12 @@ public function getRouterConfig(): array
return [
'routes' => [
'lmcadmin' => [
- 'type' => 'literal',
+ 'type' => 'literal',
'options' => [
- 'route' => '/admin',
+ 'route' => '/admin',
'defaults' => [
'controller' => Controller\AdminController::class,
- 'action' => 'index',
+ 'action' => 'index',
],
],
'may_terminate' => true,