README

AdminBundle

The AdminBundle let you create a flexible and robust backoffice on any Symfony application, with simple yaml configuration.

It eases the handling of CRUD views by configuring Admin objects on top of your Doctrine entities. Each Admin has one or many Action. By default, the four actions of a classical CRUD are available (create, edit, delete and list) and the creation of custom actions is easy.

If you require more flexibility, you can easily override any part of the process (data providers, controllers, views...). The purpose of the bundle is to provide an Admin interface with default configuration, and allows the user to add his specific need where he wants, and allow to implement any specific needs without any hassles.

Features

Dynamic CRUD for your entities (no code generation)
Simple yaml configuration
List with pagination, sorting and filters
Menus integrations
Fully customizable (use your own controllers, data providers or templates)
Bootstrap 4 integration (can be disabled or override)

Installation

Step 1: Install the Bundle

Open a command console, execute the following command in your project directory to install the latest stable version of the bundle:

composer require lag/adminbundle

If you do not use flex, read the extra steps to install the bundle

Step 2: Configure the routing

Import the routing configuration to have the admin generated routes :

    # config/routes.yaml        
    lag_admin:
        resource: '@LAGAdminBundle/Resources/config/routing/routing.yaml'
        prefix: /admin

Step 3 : Configure an entity

# config/packages/lag_admin.yaml
lag_admin:
    application:
        title: My Little TaunTaun application

# config/admin/resources/article.yaml
article:
    entity: App\Entity\Article 
    actions:
        create: ~
        edit: ~
        list: ~
        delete: ~

As new routes are dynamically created, the cache clearing is required (symfony cache:clear)

Now you could visit http://127.0.0.1:8000/admin/article/list to see a list of your entities.

Yan can visit http://127.0.0.1:8000/app_dev.php/admin/ to see the homepage of your admin interface

Documentation

How to use
- a. Basics
- b. Admins
- c. Actions
- d. Fields
- e. Events
- f. Data Providers
- g. Filters
- h. Views
- i. Security
Customization
- a. Custom actions
- b. Custom render
- c. Custom data
- d. Custom routes and urls
Reference
- a. Application configuration
- b. Admin configuration
FAQ
Configuration reference

Testing

To run the admin test suite, run the following :

make tests

Road map

v1.1

Add dynamic id column (instead of required "id" column) to improve generic and handle multiple ids columns

v1.0

Add more testing

History

Version 0.4 :

Dynamic CRUD for your entities (no code generation)
Simple configuration in yml (look alike symfony1 generators.yml syntax)
List with pagination, sorting and batch remove (filters are coming)
Full translated
Main and left menu integration
Fully customizable (use your own controllers, data providers or templates)
Bootstrap 3 integration (can be disabled or override)

lag / adminbundle

Maintainers

Details