vctls/select2entity-extension-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

An extension of TetranzSelect2EntityBundle with a couple helper classes.

1.0 2019-04-02 12:05 UTC

Requires

• php: >=5.4.0
• doctrine/orm: >=2.4

MIT

• Victor Toulouse

• symfony
• autocomplete
• select2
• typeahead

README

This bundle provides helpers for working with Tetranz Select2EntityBundle.

Searcher classes define configuration for the entities used in Select2 fields.

Configuration

Add routing to the default controller:

# routes.yml
vctls_select2_entity_extension:
    resource: '@VctlsSelect2EntityExtensionBundle/Resources/config/routing.yaml'

Add the namespace of your Searcher classes in config.yml. Default is App\Util:

# config.yml
vctls_select2_entity_extension:
    searcher_namespace: 'App\Tools\Select2\'

Creating Select2 fields:

First, create a Searcher class for the entity you want to use in your field.

<?php

namespace App\Util;

use Vctls\Select2EntityExtensionBundle\Util\Searcher;

class ExampleSearcher extends Searcher
{
    public $alias = 'example';
    public $idMethod = 'getId';
    public $textMethod = '__toString';
    public $searchfileds = ['example.name'];
}

Then, add a Select2 field in your form:

<?php

namespace App\Form\Example;

use App\Entity\Example;
use Vctls\Select2EntityExtensionBundle\Util\S2;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;

class ExampleType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        // with the helper class...
        $builder->add(...S2::build('example', Example::class));
        
        // or without it
        $builder->add('example2', Select2EntityType::class, [
            'remote_route' => 'generic_autocomplete',
            'remote_params' => [
                'classname' => Example::class
            ],
            'class' => Example::class,
            'primary_key' => 'id',
            'text_property' => 'name',
            'minimum_input_length' => 2,
            'delay' => 250,
            'cache' => true,
            'placeholder' => 'Select an example',
        ]);
    }
}

Secure access to the default controller

You can create a Voter that will controll access to different entities.

<?php
// App\Security\EntityVoter.php
namespace App\Security;

use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Authorization\Voter\Voter;
use App\Entity;

class EntityVoter extends Voter
{
    const ENTITIES_BY_ROLE = [
        'ROLE_USER' => [
            Entity\Example::class
        ],
        'ROLE_ADMIN' => [
            Entity\User::class
        ]
    ];
    
    protected function supports($access, $subject)
    {
        return $access === 'view' && gettype($subject) === 'string';
    }

    protected function voteOnAttribute($access, $subject, TokenInterface $token)
    {
        $roles = $token->getRoles();

        foreach ($roles as $role) {
            if (in_array($subject, self::ENTITIES_BY_ROLE[$role->getRole()])) {
                return true;
            }
        }   
        return false;
    }
}