1.1 Création d’un contrôleur CRUD pour l’entité Location

Nous allons dans un premier temps crée un contrôleur pour gérer l’entité Location, puis générer les formulaires de saisie et de modification d’une location en utilisant la fabrique de formulaires proposée par Symfony.

Symfony crée automatiquement les vues et les formulaires. Nous allons modifier les formulaires pour les adapter plus précisément à nos besoins.

Créez un contrôleur CRUD pour l’entité Location.

Ajouter une page qui affiche la liste des locations pour une salle.

1.2 Etude et modification d’un formulaire

Dans le listing qui suit, on retrouve la fonction new du contrôleur LocationController qui permet d’afficher un formulaire de création d’une nouvelle location.

   public function new(Request $request): Response
    {
        $location = new Location();
        $form = $this->createForm(LocationType::class, $location);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            $em = $this->getDoctrine()->getManager();
            $em->persist($location);
            $em->flush();

            return $this->redirectToRoute('location_index');
        }

        return $this->render('location/new.html.twig', [
            'location' => $location,
            'form' => $form->createView(),
        ]);
    }

• L’instruction $form = $this->createForm(LocationType::class, $location); crée une instance de la classe Form à partir de la classe Location en utilisant comme données de départ l’instance de la classe Location $location.
• L’instruction $form->handleRequest($request); permet de gérer le traitement de la saisie du formulaire. En effet sans autre précision, lorsque l’utilisateur valide la saisie du formulaire, une requête HTTP avec la commande POST est transmise avec la même url que celle qui à provoquer l’affichage du formulaire (ici /location/new). Le contenu de la requête est traitée et les données affectées aux propriétés de l’instance qui a été donnée en paramètre de l’instruction précédente (ici $location).
• C’est l’instruction $form->isSubmitted() qui permet de savoir si le formulaire a été saisi et si de plus les règles de validations sont vérifiées ($form->isValid()) alors l’enregistrement sera ajouté à la base de données avant de rediriger la requête vers un affichage de la liste des locations.
• L’instruction $this->render(...) permet d’afficher le formulaire.

Dans l’état, si on essaie de créer une nouvelle instance de la classe Location on obtient une erreur (Catchable Fatal Error: Object of class App\Entity\Salle could not be converted to string), il nous faut donc adapter ce formulaire.

Pour utiliser des règles de validation (voir la documentation ici) qui soient plus personnelles il faut ajouter une librairie avec la commande suivante :

 composer require symfony/validator

Dès que la librairie aura été ajoutée, il vous sera possible d’ajouter des contraintes dans la classe modèle qui permettront de valider ou non plus finement que l’instance est correcte ou non (voir la documentation).

Par exemple voici une modification de la classe modèle Salle :

<?php

namespace App\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ORM\Entity(repositoryClass="App\Repository\SalleRepository")
 */
class Salle {
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=20)
     * @Assert\NotBlank()
     */
    private $nom;

    /**
     * @ORM\Column(type="string", length=30)
     * @Assert\NotBlank()
     */
    private $batiment;

    // suite du code ....
}

On aura noté l’ajout de l’annotation @Assert\NotBlank() qui vérifie que le champ n’est pas vide.

On peut aussi vérifier que les valeurs données sont correctes, par exemple si l’on veut vérifier que lors de la création d’une nouvelle location, la salle sélectionnée n’est pas déjà louée dans la même période, on utilise une classe contrainte.

Une classe contrainte permet de définir un nouveau type de contrainte (documentation), dans notre cas ContrainteSalleLibre. Cette classe peut être vu comme une étiquette qui va déclencher une classe qui va valider ou non la contrainte, dans notre cas ContrainteSalleLibreValidator. Il est possible d’utiliser un autre nom, mais dans ce cas, il faut indiquer son nom en ajoutant la fonction validatedBy dans la classe ContrainteSalleLibre :

    public function validatedBy() {
        return \get_class($this).'Validation';
    }

La classe ContrainteSalleLibreValidator doit contenir une fonction validate($value, Constraint $constraint) qui vérifie que la contrainte est vérifiée ou produit une violation de contrainte :

<?php
<?php

namespace App\Validator;


use App\Entity\Salle;
use App\Entity\Location;
use Doctrine\Common\Persistence\ObjectManager;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;

class ContrainteSalleLibreValidation extends ConstraintValidator {

    protected $em;
    public function __construct(ObjectManager $entityManager) {
        $this->em = $entityManager;
    }


    /**
     * Checks if the passed value is valid.
     *
     * @param mixed $value The value that should be validated
     * @param Constraint $constraint The constraint for the validation
     */
    public function validate($value, Constraint $constraint) {
        // custom constraints should ignore null and empty values to allow
        // other constraints (NotBlank, NotNull, etc.) take care of that
        if (null === $value || '' === $value) {
            return;
        }

        if (!($value instanceof Location)) {
            throw new UnexpectedTypeException($value, 'Location');
        }

        if (!$this->isSalleLibre($value)) {
            $this->context->buildViolation($constraint->message)
                ->setParameter('{{ salle }}', $value->getSalle()->getNom().', '.$value->getSalle()->getBatiment())
                ->addViolation();
        }
    }

    public function isSalleLibre(Location $value) {
        // code à écrire
        return false;
    }


}

Modifiez la vue qui liste les locations et ajouter le nom de la salle louée.

Modifiez la vue qui permet de saisir une nouvelle location.

Ajouter une nouvelle contrainte qui n’accepte que les locations de salles libres (on ne peut pas louer une salle qui est déjà louée).