newquery/symfony-entity-order

Add a new property to you entity 'positionOrder' so you can give your items a position in a sorted collection

dev-main 2021-06-17 20:04 UTC

Requires

• doctrine/orm: ^2.8
• doctrine/persistence: ^2.1
• symfony/config: 5.2.*
• symfony/dependency-injection: 5.2.*
• symfony/http-kernel: 5.2.*
• symfony/string: 5.2.*

MIT

• newQuery

• symfony
• order
• sort
• position
• sorting
• newquery

README

Helps to create ordered list from Entities.

Usage

Add the trait to the desired entity

namespace App\Entity\Misc;  
  
use App\Repository\Misc\TeamMemberRepository;  
use Doctrine\Common\Collections\ArrayCollection;  
use Doctrine\Common\Collections\Collection;  
use Doctrine\ORM\Mapping as ORM;  
use newQuery\Bundle\EntityOrder\Lib\OrderEntity;  
use Symfony\Component\Validator\Constraints as Assert;  
  
/**  
 * @ORM\Entity(repositoryClass=TeamMemberRepository::class)  
 * @ORM\HasLifecycleCallbacks()  
 */
 class TeamMember  
{  
  
  use OrderEntity;  // THIS 
  
  /**  
  * @ORM\Id  
  * @ORM\GeneratedValue  
  * @ORM\Column(type="integer")  
  */  
  private $id;

Make sure to add @ORM\HasLifecycleCallbacks()

Enjoy, your entity now has the positionOrder property.

Create a dynamic Controller for increasing/decreasing the position

/**
 * @Route("/increase/{className}/{id}", name="increase_position")
 */
public function increase(string $className, int $id, OrderPositionHelper $helper, Request $request): Response
{
    $em = $this->getDoctrine()->getManager();
    $meta = $em->getMetadataFactory()->getAllMetadata();

    $repository = null;
    foreach ($meta as $m) {
        if(strpos($m->getName(), 'App\Entity') !== false && strpos($m->getName(), $className) !== false) {
            $repository = $em->getRepository($m->getName());
            break;
        }
    }

    if(null !== $repository) {
        $result = $helper->increase($repository, $id);
        $this->getDoctrine()->getManager()->flush();

        if(true === $result) {
            $this->addFlash('success', 'Ordre mis à jour!');
        }
    }

    return $this->redirect($request->headers->get('referer'));
}

 /**
 * @Route("/decrease/{className}/{id}", name="decrease_position")
 */
public function decrease(string $className, int $id, OrderPositionHelper $helper, Request $request): Response
{
    $em = $this->getDoctrine()->getManager();
    $meta = $em->getMetadataFactory()->getAllMetadata();

    $repository = null;
    foreach ($meta as $m) {
        if(strpos($m->getName(), 'App\Entity') !== false && strpos($m->getName(), $className) !== false) {
            $repository = $em->getRepository($m->getName());
            break;
        }
    }

    if(null !== $repository) {
        $result = $helper->decrease($repository, $id);
        $this->getDoctrine()->getManager()->flush();

        if(true === $result) {
            $this->addFlash('success', 'Ordre mis à jour!');
        }
    }

    return $this->redirect($request->headers->get('referer'));
}

In twig template:

<a class="btn btn-primary" href="{{ path('decrease_position', {'id': member.id, 'className': 'TeamMember'}) }}">-</a>
<a class="btn btn-primary" href="{{ path('increase_position', {'id': member.id, 'className': 'TeamMember'}) }}">+</a>

Error

You can fix the order of all element from one or all entities using the trait with $ php bin/console nq:position-order:fix <?Entity>