Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added test suites. Update view template. Added listeners, module options, etc #33

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2013, ZF-Commons Contributors
Copyright (c) 2024, LM-Commons Contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,32 @@
[![PHP Version Require](http://poser.pugx.org/lm-commons/lmc-admin/require/php)](https://packagist.org/packages/lm-commons/lmc-admin)

# LmcAdmin Module for Laminas Framework
Created by [Jurian Sluiman](http://juriansluiman.nl) and [Martin Shwalbe](https://github.com/Hounddog).
Originally created by [Jurian Sluiman](http://juriansluiman.nl) and [Martin Shwalbe](https://github.com/Hounddog).

## Introduction
LmcAdmin is a minimal admin interface for generic administrative purposes. It is a common screen with navigation that hides behind authentication and authorization.

## Requirements

- PHP 8.1 or higher

## Installation
LmcAdmin is enabled to be installed via composer. Load `lm-commons/lmc-admin` in your `composer.json` file. You can specify its version (currently only 1.0.0 is recommended) or use `dev-master` to load the latest version from master. Enable LmcAdmin in your `module.config.php` configuration file.
LmcAdmin is enabled to be installed via composer.

If you do not want to use composer, clone this project (either as a git submodule or not) into `./vendor/` directory.
```bash
$ composer require lm-commons/lmc-admin
```
Enable the module by adding `Lmc\Admin` key to your `application.config.php` or `modules.config.php` file.

## Usage
LmcAdmin allows you to create routes under a single parent "admin" route. You can also use it to enable navigation in your admin layout. Furthermore integration of [LmcRbacMvc](https://github.com/LM-Commons/LmcRbacMvc) is provided.
Customize the module by copy-pasting the `config/lmcadmin.global.php.dist` file to your `config/autoload` folder.

The complete configuration is flexible, so you can update the zfcadmin parent route, its children, the navigation and all default provided view scripts. Read more in the [documentation](docs-old/1.Introduction.md) about usage and customization of LmcAdmin.
## Usage
LmcAdmin allows you to create routes under a single parent "lmcadmin" route. You can also use it to enable navigation in
your admin layout. Furthermore, integration of [LmcRbacMvc](https://github.com/LM-Commons/LmcRbacMvc) is provided.

## Development
LmcAdmin is currently under development. The authors feel LmcAdmin is stable enough for production versions and you can always fix your LmcAdmin version to a specific tag.
The complete configuration is flexible, so you can update the lmc_admin parent route, its children, the navigation
and all default provided view scripts. Read more in the [documentation](https://lm-commons.github.io/LmcAdmin) about
usage and customization of LmcAdmin.

## Support

Expand Down
9 changes: 5 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
},
"autoload": {
"psr-4": {
"LmcAdmin\\": "src/"
"Lmc\\Admin\\": "src/"
}
},
"autoload-dev": {
Expand All @@ -35,16 +35,17 @@
}
},
"extra": {
"lm": {
"component": "LmcAdmin",
"laminas": {
"component": "Lmc\\Admin",
"config-provider": [
"LmcAdmin\\ConfigProvider"
]
}
},
"require-dev": {
"laminas/laminas-coding-standard": "^2.5",
"phpunit/phpunit": "^10.5.30",
"laminas/laminas-test": "^4.10",
"phpunit/phpunit": "^10.5.30 || ^11.3.0",
"psalm/plugin-phpunit": "^0.19.0",
"vimeo/psalm": "^5.25"
},
Expand Down
Loading