The goal of this bundle is to make the use of SonataAdmin "view-models" possible without writting a line of PHP, without loosing a feature of Sonata, and importing the idea of composite settings using lots of characteristics of an admin (its direct inheritance tree, the traits used by its Entity, the inheritance tree of its Entity...), making things more flexible, extendable, reusable and maintenable through many bundles and uses.
This bundle is the next step after the SonataAdminBundle. Configure an entire backend bundle filling only YAML files... Try it!
It is also the core of the core of Libre Informatique's Symfony 2/3 projects.
I want to design and create a bundle as a toolbox for other bundles' entities. It will provide traits for email addresses and phonenumbers, for instance (cf. LibrinfoBaseEntitiesBundle).
Using the LibrinfoCoreBundle, your "base" bundle will carry the traits, but also the way to display properties given by its traits in a SonataAdmin (which becomes a CoreAdmin) CRUD. Then using the traits of your "base" bundle in the entities of other bundles (also implementing the LibrinfoCoreBundle) will add the fields naturally, the columns in the list of objects, etc... as you set up for your trait in your "base" bundle, without having to write a line for this.
Imagine this feature appliable to 50 entities distributed in 10 bundles, and count in your mind the number of saved lines, the number of potential bugs avoided and the ease of maintenance when you want to change the nature of the field used by the provided email address or phonenumber... This is what the LibrinfoCoreBundle permits.
- having a working Symfony2 environment
- having created a working Symfony2 app (including your DB and your DB link)
- having composer installed (here in /usr/local/bin/composer, with /usr/local/bin in the path)
$ composer require libre-informatique/core-bundle dev-master
This will download and install :
- knplabs/knp-menu
- knplabs/knp-menu-bundle
- cocur/slugify
- sonata-project/core-bundle
- sonata-project/cache
- sonata-project/block-bundle
- sonata-project/exporter
- twig/extensions
- sonata-project/admin-bundle
- sonata-project/doctrine-orm-admin-bundle
- libre-informatique/core-bundle
- libre-informatique/base-entities-bundle
- twig/twig ^1.22.1
Please refer to the Sonata Project's instructions, foundable here : https://sonata-project.org/bundles/admin/2-3/doc/reference/installation.html
Create the database needed
If you are using PostgreSQL as your main database, you'll need to install postgresql-contrib and load the "uuid-ossp" extension :
$ sudo apt-get install postgresql-contrib
$ echo 'CREATE EXTENSION "uuid-ossp";' | psql [DB]
Edit your app/AppKernel.php file and add your "libre-informatique" bundle, for instance the "libre-informatique/core-bundle" :
// app/AppKernel.php
// ...
public function registerBundles()
{
$bundles = array(
// ...
// The libre-informatique bundles
new Librinfo\CoreBundle\LibrinfoCoreBundle(),
// your personal bundles
);
}
Discover the configuration of the CoreBundle
.
Improving the SonataAdminBundle in a generic way
Discover the configuration of a standalone bundle.
Instead of the Librinfo\CoreBundle\Admin\Traits\Base
trait, you might be interested in :
Librinfo\CoreBundle\Admin\Traits\Embedded
: if the currentCoreAdmin
aims to be embeddedLibrinfo\CoreBundle\Admin\Traits\Embedding
: if the currentCoreAdmin
aims to embed other forms and you want its embedding fields to be treated automatically
If needed, you can easly use the LibrinfoCoreBundle in combination with other bundles from the Sonata Project, for instance :
- sonata-project/intl-bundle
- sonata-project/notification-bundle
- sonata-project/user-bundle
- sonata-project/formatter-bundle
Please refer yourself to the proper documentation from the Sonata Project...