Developed with love by KnpLabs Hire us for your project!
94

GeneratorBundle

by symfony2admingenerator

Admingenerator for Symfony. Parse YAML files to build customized backend.

AdminGenerator knpbundles.com SensioLabsInsight

Build Status
Scrutinizer Code Quality
Code Coverage

PHP Dependency Status
JS Dependency Status

Latest Stable Version
Total Downloads
License

1. Quick tour:

This bundle helps you quickly create powerful CRUD backend. Customizing the standard functionalities is simple - you can easily overwrite any part of the generated code. Most features can be configured in one (per model) YAML file. Advanced examples are covered in our cookbook, accessible through our documentation. For a quick preview visit our demo project.

2. Highlights:

  • one command to generate full CRUD for a model
  • one configuration file (per model) to customize your backend
  • supports popular model managers: Doctrine ORM, Doctrine ODM and Propel
  • admin design based on AdminLTE v2
  • active community, support on Gitter Chat

3. Features:

List view:

  • sorting
  • pagination
  • filters
  • scopes
  • button links to object actions
  • check rows to select and perform batch actions

Nestedset List view:

  • drag & drop to manage your tree

New / Edit form:

  • group fields in fieldsets
  • group fieldsets in tabs
  • dedicated bundle with additional form types
  • add/remove fields to the form based on credential checks
  • display errors next to fields when form is invalid
  • display error count for each tab
  • (optional) help blocks
  • button links to object actions

Show view:

  • add/remove displayed fields based on credential checks
  • button links to object actions

4. Documentation

The documentation for this bundle can be found in Resources/doc directory.

5. Community and support

If you're having trouble or you found an error feel free to open a github ticket, but first please read submitting issues.
You can also find help on our chat. If you like this bundle join our SensioConnect club, follow us on Twitter and recommend us on KnpBundles.

Gitter Join Chat
Follow @sf2admgen
SensioConnect join the club
KnpBundles recommend

6. Versioning

Releases will be numbered with the format major.minor.patch.

And constructed with the following guidelines.

  • Breaking backwards compatibility bumps the major.
  • New additions without breaking backwards compatibility bumps the minor.
  • Bug fixes and misc changes bump the patch.

For more information on SemVer, please visit semver.org website.

When upgrading the to the newest build, always check our upgrade notes.

7. Contributing

This bundle follows branching model described in A successful git branching model blog post by Vincent Driessen.

  • The master branch is used to tag stable releases.
  • The develop branch is used to develop small changes and merge feature branches into it.
  • The feature- branches are used to develop features. When ready, submit a PR to develop branch.
  • The hotfixes branch is used to develop fixes to severe bugs in stable releases. When ready, the fix is merged both to develop and master branches.
  • The release branches (eg. 1.1) are created for each minor release and only patches will be merged into them.

Branching model

8. This bundle in pictures

By default, this Bundle uses the AdminLTE templates. See its documentation to create your own widget and customize the interface.

Preview of dashboard

Preview of list

Preview of nested list

Preview of edit

9. License

This bundle is released under the MIT License except for the file: Resources/doc/img/branching-model.png by Vincent Driessen, which is released under Creative Commons BY-SA.

Copyright (c) 2011-2012 Cedric LOMBARDOT

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
:
use_doctrine_orm: false
use_doctrine_odm: false
use_propel: false
use_jms_security: false
guess_required: true
default_required: true
overwrite_if_exists: false
throw_exceptions: false
base_admin_template: AdmingeneratorGeneratorBundle::base.html.twig
dashboard_route: ~
login_route: ~
logout_route: ~
exit_route: ~
generator_cache: ~
default_action_after_save: edit
knp_menu_alias: ~
use_doctrine_orm_batch_remove: false
use_doctrine_odm_batch_remove: false
use_propel_batch_remove: false
twig:
use_form_resources: true
use_localized_date: false
date_format: Y-m-d
datetime_format: Y-m-d H:i:s
localized_date_format: medium
localized_datetime_format: medium
number_format:
decimal: 0
decimal_point: .
thousand_separator: ,
templates_dirs: []
form_types:
doctrine_orm:

# Prototype
name: []
doctrine_odm:

# Prototype
name: []
propel:

# Prototype
name: []
filter_types:
doctrine_orm:

# Prototype
name: []
doctrine_odm:

# Prototype
name: []
propel:

# Prototype
name: []
stylesheets:
path: ~
media: all
javascripts:
path: ~
route: ~
routeparams:

# Prototype
key: []
  • Removed author to prevent cache clear warnings
    By web-flow, 11 months ago
  • Prevent issues with Doctrine Inflector due to null string
    By tobias-93, 1 year ago
  • Updated sizeof usage to be fully compatible with php7.2 (#323)
    By bobvandevijver, 1 year ago
  • Fixed documentation indentation mistake
    By web-flow, 1 year ago
  • Fixed documentation indentation mistake
    By web-flow, 1 year ago
  • Add choice_translation_domain to boolean filters to make sure labels are translated
    By tobias-93, 2 years ago
  • Release 2.5.0
    By web-flow, 2 years ago
  • Merge pull request #320 from symfony2admingenerator/phpspreadsheet
    By web-flow, 2 years ago
  • Implement PHPSpreadsheet compatibility
    By tobias-93, 2 years ago
  • Fix type error in options generation for numeric type
    By web-flow, 2 years ago
  • Fixed @return annotation in ActionsController
    By bobvandevijver, 2 years ago
  • Merge pull request #316 from coke54/master
    By web-flow, 2 years ago
  • Missing var added for variable declaration in scope:
    By coke54, 2 years ago
  • Prevent double translation in Filter form label by treating it the same as edit or new form labels (#315)
    By web-flow, 2 years ago
  • Add missing Dutch translation
    By tobias-93, 2 years ago
  • Fixed #312, UUID can be used for entity IDs, it is enough to check only route which is sent. (#313)
    By tobias-93, 2 years ago
  • Fix service naming for form types for multiple admins for one entity
    By tobias-93, 2 years ago
  • Update Dutch translations
    By web-flow, 2 years ago
  • Register spl_autoloader sooner to work with Symfony3+
    By sescandell, 3 years ago
  • Fix Twig
    By sescandell, 3 years ago
  • Twig 2.0 support
    By sescandell, 3 years ago
  • Improve PHPDoc for queryfilter methods
    By tobias-93, 3 years ago
  • Fix bug when using a comma in querybuilder options
    By tobias-93, 3 years ago
  • Autodetect the Symfony MoneyType for list views
    By web-flow, 3 years ago
  • Clarify scopes definition
    By web-flow, 3 years ago
  • Small PHP-doc fixes in generated templates
    By bobvandevijver, 3 years ago
  • Update base-installation.md
    By web-flow, 3 years ago
  • Merge pull request #302 from RunOpenCode/master
    By web-flow, 3 years ago
  • Addendum to list builder documentation - default sort explained.
    By TheCelavi, 3 years ago
  • Removed double DateTime format check
    By web-flow, 3 years ago