Symfony2 Jobeet Day 12: Sonata Admin Bundle

* This article is part of the original Jobeet Tutorial, created by Fabien Potencier, for Symfony 1.4.
With the addition we made in Day 11 on Jobeet, the application is now fully usable by job seekers and job posters. It’s time to talk a bit about the admin section of our application. Today, thanks to the Sonata Admin Bundle, we will develop a complete admin interface for Jobeet in less than an hour.

Table of Contents

Installation of the Sonata Admin Bundle

Start by downloading SonataAdminBundle and its dependencies to the vendor directory:

1	php composer.phar require sonata-project/admin-bundle

To install the latest version of the SonataAdminBundle and its dependencies, give * as input.

1 2	ibw@ubuntu:/var/www/jobeet$ php composer.phar require sonata-project/admin-bundle Please provide a version constraint for the sonata-project/admin-bundle requirement: *

We will also need to install the SonataDoctrineORMADminBundle:

1	php composer.phar require sonata-project/doctrine-orm-admin-bundle

Now, we need to declare these new bundles and dependencies, so go to your AppKernel.php file and add the following code:

// ...

public function registerBundles()

{

$bundles = array(

// ...

new SonataAdminBundleSonataAdminBundle(),

new SonataBlockBundleSonataBlockBundle(),

new SonatajQueryBundleSonatajQueryBundle(),

new SonataDoctrineORMAdminBundleSonataDoctrineORMAdminBundle(),

new KnpBundleMenuBundleKnpMenuBundle(),

);

}

// ...

You will need to alter your config file as well. Add the following at the end:

# ...

sonata_admin:

title: Jobeet Admin

sonata_block:

default_contexts: [cms]

blocks:

sonata.admin.block.admin_list:

contexts: [admin]

sonata.block.service.text:

sonata.block.service.action:

sonata.block.service.rss:

Also, look for the translator key and uncomment if it is commented:

# ...

framework:

# ...

translator: { fallback: %locale%}

# ...

#...

For your application to work, you need to import the admin routes into the application’s routing file:

admin:

resource: '@SonataAdminBundle/Resources/config/routing/sonata_admin.xml'

prefix: /admin

_sonata_admin:

resource: .

type: sonata_admin

prefix: /admin

# ...

1	php app/console assets:install web --symlink

Do not forget to delete your cache:

1 2	php app/console cache:clear --env=dev php app/console cache:clear --env=prod

You should now be able to access the admin dashboard using the following url: http://jobeet.local/app_dev.php/admin/dashboard

The CRUD Controller

The CRUD controller contains the basic CRUD actions. It is related to one Admin class by mapping the controller name to the correct Admin instance. Any or all actions can be overwritten to suit the project’s requirements. The controller uses the Admin class to construct the different actions. Inside the controller, the Admin object is accessible through the configuration property.

Now let’s create a controller for each entity. First, for the Category entity:

namespace IbwJobeetBundleController;

use SonataAdminBundleControllerCRUDController as Controller;

class CategoryAdminController extends Controller

{

// Your code will be here

}

And now for the Job:

namespace IbwJobeetBundleController;

use SonataAdminBundleControllerCRUDController as Controller;

class JobAdminController extends Controller

{

// Your code will be here

}

Creating the Admin class

The Admin class represents the mapping of your model and administration sections (forms, list, show). The easiest way to create an admin class for your model is to extend the SonataAdminBundleAdminAdmin class. We will create the Admin classes in the Admin folder of our bundle. Start by creating the Admin directory and then, the Admin class for categories:

namespace IbwJobeetBundleAdmin;

use SonataAdminBundleAdminAdmin;

use SonataAdminBundleDatagridListMapper;

use SonataAdminBundleDatagridDatagridMapper;

use SonataAdminBundleValidatorErrorElement;

use SonataAdminBundleFormFormMapper;

class CategoryAdmin extends Admin

{

// Your code will be here

}

And for jobs:

namespace IbwJobeetBundleAdmin;

use SonataAdminBundleAdminAdmin;

use SonataAdminBundleDatagridListMapper;

use SonataAdminBundleDatagridDatagridMapper;

use SonataAdminBundleValidatorErrorElement;

use SonataAdminBundleFormFormMapper;

use SonataAdminBundleShowShowMapper;

use IbwJobeetBundleEntityJob;

class JobAdmin extends Admin

{

// Your code will be here

}

Now we need to add each admin class in the services.yml configuration file:

services:

ibw.jobeet.admin.category:

class: IbwJobeetBundleAdminCategoryAdmin

tags:

- { name: sonata.admin, manager_type: orm, group: jobeet, label: Categories }

arguments:

- ~

- IbwJobeetBundleEntityCategory

- 'IbwJobeetBundle:CategoryAdmin'

ibw.jobeet.admin.job:

class: IbwJobeetBundleAdminJobAdmin

tags:

- { name: sonata.admin, manager_type: orm, group: jobeet, label: Jobs }

arguments:

- ~

- IbwJobeetBundleEntityJob

- 'IbwJobeetBundle:JobAdmin'

At this point, we can see in the dashboard the Jobeet group and, inside it, the Job and Category modules, with their respective add and list links.

Configuration of Admin classes

If you follow any link right now, nothing will happen. That’s because we haven’t configure the fields that belong to the list and the form. Let’s do a basic configuration, first for the categories:

namespace IbwJobeetBundleAdmin;

use SonataAdminBundleAdminAdmin;

use SonataAdminBundleDatagridListMapper;

use SonataAdminBundleDatagridDatagridMapper;

use SonataAdminBundleValidatorErrorElement;

use SonataAdminBundleFormFormMapper;

class CategoryAdmin extends Admin

{

// setup the default sort column and order

protected $datagridValues = array(

'_sort_order' => 'ASC',

'_sort_by' => 'name'

);

protected function configureFormFields(FormMapper $formMapper)

{

$formMapper

->add('name')

->add('slug')

;

}

protected function configureDatagridFilters(DatagridMapper $datagridMapper)

{

$datagridMapper

->add('name')

;

}

protected function configureListFields(ListMapper $listMapper)

{

$listMapper

->addIdentifier('name')

->add('slug')

;

}

And now for jobs:

namespace IbwJobeetBundleAdmin;

use SonataAdminBundleAdminAdmin;
use SonataAdminBundleDatagridListMapper;
use SonataAdminBundleDatagridDatagridMapper;
use SonataAdminBundleValidatorErrorElement;
use SonataAdminBundleFormFormMapper;
use SonataAdminBundleShowShowMapper;
use IbwJobeetBundleEntityJob;

class JobAdmin extends Admin
{
    // setup the defaut sort column and order
    protected $datagridValues = array(
        '_sort_order' => 'DESC',
        '_sort_by' => 'created_at'
    );

protected function configureFormFields(FormMapper $formMapper)
    {
        $formMapper
            ->add('category')
            ->add('type', 'choice', array('choices' => Job::getTypes(), 'expanded' => true))
            ->add('company')
            ->add('file', 'file', array('label' => 'Company logo', 'required' => false))
            ->add('url')
            ->add('position')
            ->add('location')
            ->add('description')
            ->add('how_to_apply')
            ->add('is_public')
            ->add('email')
            ->add('is_activated')
        ;
    }

protected function configureDatagridFilters(DatagridMapper $datagridMapper)
    {
        $datagridMapper
            ->add('category')
            ->add('company')
            ->add('position')
            ->add('description')
            ->add('is_activated')
            ->add('is_public')
            ->add('email')
            ->add('expires_at')
        ;
    }

protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->addIdentifier('company')
            ->add('position')
            ->add('location')
            ->add('url')
            ->add('is_activated')
            ->add('email')
            ->add('category')
            ->add('expires_at')
            ->add('_action', 'actions', array(
                'actions' => array(
                    'view' => array(),
                    'edit' => array(),
                    'delete' => array(),
                )
            ))
        ;
    }

protected function configureShowField(ShowMapper $showMapper)
    {
        $showMapper
            ->add('category')
            ->add('type')
            ->add('company')
            ->add('webPath', 'string', array('template' => 'IbwJobeetBundle:JobAdmin:list_image.html.twig'))
            ->add('url')
            ->add('position')
            ->add('location')
            ->add('description')
            ->add('how_to_apply')
            ->add('is_public')
            ->add('is_activated')
            ->add('token')
            ->add('email')
            ->add('expires_at')
        ;
    }
}

namespace IbwJobeetBundleAdmin;

use SonataAdminBundleAdminAdmin;

use SonataAdminBundleDatagridListMapper;

use SonataAdminBundleDatagridDatagridMapper;

use SonataAdminBundleValidatorErrorElement;

use SonataAdminBundleFormFormMapper;

use SonataAdminBundleShowShowMapper;

use IbwJobeetBundleEntityJob;

class JobAdmin extends Admin

{

// setup the defaut sort column and order

protected $datagridValues = array(

'_sort_order' => 'DESC',

'_sort_by' => 'created_at'

);

protected function configureFormFields(FormMapper $formMapper)

{

$formMapper

->add('category')

->add('type', 'choice', array('choices' => Job::getTypes(), 'expanded' => true))

->add('company')

->add('file', 'file', array('label' => 'Company logo', 'required' => false))

->add('url')

->add('position')

->add('location')

->add('description')

->add('how_to_apply')

->add('is_public')

->add('email')

->add('is_activated')

;

}

protected function configureDatagridFilters(DatagridMapper $datagridMapper)

{

$datagridMapper

->add('category')

->add('company')

->add('position')

->add('description')

->add('is_activated')

->add('is_public')

->add('email')

->add('expires_at')

;

}

protected function configureListFields(ListMapper $listMapper)

{

$listMapper

->addIdentifier('company')

->add('position')

->add('location')

->add('url')

->add('is_activated')

->add('email')

->add('category')

->add('expires_at')

->add('_action', 'actions', array(

'actions' => array(

'view' => array(),

'edit' => array(),

'delete' => array(),

)

))

;

}

protected function configureShowField(ShowMapper $showMapper)

{

$showMapper

->add('category')

->add('type')

->add('company')

->add('webPath', 'string', array('template' => 'IbwJobeetBundle:JobAdmin:list_image.html.twig'))

->add('url')

->add('position')

->add('location')

->add('description')

->add('how_to_apply')

->add('is_public')

->add('is_activated')

->add('token')

->add('email')

->add('expires_at')

;

}

For the show action we used a custom template to show the logo of the company:

<tr>

</tr>

With this, we created a basic administration module with operations for our jobs and categories. Some of the features you will find when using it are:

The list of objects is paginated
The list is sortable
The list can be filtered
Objects can be created, edited, and deleted
Selected objects can be deleted in a batch
The form validation is enabled
Flash messages give immediate feedback to the user

Batch Actions

Batch actions are actions triggered on a set of selected models (all of them or only a specific subset). You can easily add some custom batch action in the list view. By default, the delete action allows you to remove several entries at once.

To add a new batch action we have to override the getBatchActions from the Admin class. We will define here a new extend action:

// ...

public function getBatchActions()

{

// retrieve the default (currently only the delete action) actions

$actions = parent::getBatchActions();

// check user permissions

if($this->hasRoute('edit') && $this->isGranted('EDIT') && $this->hasRoute('delete') && $this->isGranted('DELETE')) {

$actions['extend'] = array(

'label' => 'Extend',

'ask_confirmation' => true // If true, a confirmation will be asked before performing the action

);

}

return $actions;

}

The method batchActionExtend form the JobAdminController will be executed to achieve the core logic. The selected models are passed to the method through a query argument retrieving them. If for some reason it makes sense to perform your batch action without the default selection method (for example you defined another way, at template level, to select model at a lower granularity), the passed query is null.

namespace IbwJobeetBundleController;

use SonataAdminBundleControllerCRUDController as Controller;
use SonataDoctrineORMAdminBundleDatagridProxyQuery as ProxyQueryInterface;
use SymfonyComponentHttpFoundationRedirectResponse;

class JobAdminController extends Controller
{
    public function batchActionExtend(ProxyQueryInterface $selectedModelQuery)
    {
        if ($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {
            throw new AccessDeniedException();
        }

$modelManager = $this->admin->getModelManager();

$selectedModels = $selectedModelQuery->execute();

try {
            foreach ($selectedModels as $selectedModel) {
                $selectedModel->extend();
                $modelManager->update($selectedModel);
            }
        } catch (Exception $e) {
            $this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
        }

$this->get('session')->getFlashBag()->add('sonata_flash_success',  sprintf('The selected jobs validity has been extended until %s.', date('m/d/Y', time() + 86400 * 30)));

return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
    }
}

namespace IbwJobeetBundleController;

use SonataAdminBundleControllerCRUDController as Controller;

use SonataDoctrineORMAdminBundleDatagridProxyQuery as ProxyQueryInterface;

use SymfonyComponentHttpFoundationRedirectResponse;

class JobAdminController extends Controller

{

public function batchActionExtend(ProxyQueryInterface $selectedModelQuery)

{

if ($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {

throw new AccessDeniedException();

}

$modelManager = $this->admin->getModelManager();

$selectedModels = $selectedModelQuery->execute();

try {

foreach ($selectedModels as $selectedModel) {

$selectedModel->extend();

$modelManager->update($selectedModel);

}

} catch (Exception $e) {

$this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));

}

$this->get('session')->getFlashBag()->add('sonata_flash_success', sprintf('The selected jobs validity has been extended until %s.', date('m/d/Y', time() + 86400 * 30)));

return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));

}

Let’s add a new batch action that will delete all jobs that have not been activated by the poster for more than 60 days. For this action we don’t need to select any jobs from the list because the logic of the action will search for the matching records and delete them.

// ...

public function getBatchActions()

{

// retrieve the default (currently only the delete action) actions

$actions = parent::getBatchActions();

// check user permissions

if($this->hasRoute('edit') && $this->isGranted('EDIT') && $this->hasRoute('delete') && $this->isGranted('DELETE')){

$actions['extend'] = array(

'label' => 'Extend',

'ask_confirmation' => true // If true, a confirmation will be asked before performing the action

);

$actions['deleteNeverActivated'] = array(

'label' => 'Delete never activated jobs',

'ask_confirmation' => true // If true, a confirmation will be asked before performing the action

);

}

return $actions;

}

In addition to create the batchActionDeleteNeverActivated action, we will create a new method in our JobAdminController, batchActionDeleteNeverActivatedIsRelevant, that gets executed before any confirmation, to make sure there is actually something to confirm (in our case it will always return true because the selection of the jobs to be deleted is handled by the logic found in the JobRepository::cleanup() method.

// ...

public function batchActionDeleteNeverActivatedIsRelevant()

{

return true;

}

public function batchActionDeleteNeverActivated()

{

if ($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {

throw new AccessDeniedException();

}

$em = $this->getDoctrine()->getManager();

$nb = $em->getRepository('IbwJobeetBundle:Job')->cleanup(60);

if ($nb) {

$this->get('session')->getFlashBag()->add('sonata_flash_success', sprintf('%d never activated jobs have been deleted successfully.', $nb));

} else {

$this->get('session')->getFlashBag()->add('sonata_flash_info', 'No job to delete.');

}

return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));

}

That’s all for today! Tomorrow, we will see how to secure the admin section with a username and a password. This will be the occasion to talk about the symfony2 security.

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

Symfony2 Jobeet Day 12: Sonata Admin Bundle

Installation of the Sonata Admin Bundle

The CRUD Controller

Creating the Admin class

Configuration of Admin classes

Batch Actions

That’s all for today! Tomorrow, we will see how to secure the admin section with a username and a password. This will be the occasion to talk about the symfony2 security.

Add comment Cancel reply

Need help with your next project?

Services

Careers

Symfony2 Jobeet Day 12: Sonata Admin Bundle

Installation of the Sonata Admin Bundle

The CRUD Controller

Creating the Admin class

Configuration of Admin classes

Batch Actions

That’s all for today! Tomorrow, we will see how to secure the admin section with a username and a password. This will be the occasion to talk about the symfony2 security.

Add comment Cancel reply

Need help with your next project?

Services

Careers

Privacy Policy