Technique/Symfony/Propriétés conviviales d'entité - Historique des versions

Jordan : /* Création d'une fonction globale */

2020-02-27T14:29:24Z

Création d'une fonction globale

Jordan : /* Modification du contrôleur */

2020-02-27T10:13:20Z

Modification du contrôleur

Jordan : /* Création d'une fonction globale */

2020-02-27T10:12:05Z

Création d'une fonction globale

Jordan : /* Modification de la vue */

2020-02-26T18:25:05Z

Modification de la vue

Jordan : /* Modification du contrôleur */

2020-02-26T18:24:35Z

Modification du contrôleur

Jordan : /* Modification de la vue */

2020-02-26T17:35:41Z

Modification de la vue

Jordan : /* Modification du contrôleur */

2020-02-26T17:29:12Z

Modification du contrôleur

Jordan : /* Création d'une fonction globale */

2020-02-26T17:26:08Z

Création d'une fonction globale

Jordan : /* Mise en oeuvre */

2020-02-26T17:22:26Z

Mise en oeuvre

Jordan : /* Contexte */

2020-02-26T16:35:50Z

Contexte

@@ Ligne 135 : / Ligne 135 : @@
+         {
              $propertyAnnotations = $annotationReader->getPropertyAnnotations(new \ReflectionProperty($className, $property->getName()));
-             $propertiesNames[$property->getName()] = ((array) $propertyAnnotations[0])["friendlyName"];
+             foreach ($propertyAnnotations as $annotation)
+         }
          return $propertiesNames;

@@ Ligne 146 : / Ligne 146 : @@
 Voici un exemple d'appel de la fonction et de passage des informations à la vue depuis un contrôleur :
-<syntaxhighlight lang="php" highlight="13,34,37">
+<syntaxhighlight lang="php" highlight="12,33,36">
 <?php
 // src/Controller/ApplicationController.php
@@ Ligne 158 : / Ligne 158 : @@
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use App\Repository\ApplicationRepository;
+use App\Functions;
 /**
@@ Ligne 180 : / Ligne 179 : @@
+		}
-         $propertiesNames = getFriendlyNames('App\Entity\Application');
+         $propertiesNames = Functions::getFriendlyNames('App\Entity\Application');
          return $this->render('application/index.html.twig', [

@@ Ligne 124 : / Ligne 124 : @@
 use Doctrine\Common\Annotations\AnnotationReader;
-function getFriendlyNames ($className)
+class Functions
+{
-     $annotationReader = new AnnotationReader();
+     public static function getFriendlyNames($className)
+     {
-         $propertyAnnotations = $annotationReader->getPropertyAnnotations(new \ReflectionProperty($className, $property->getName()));
+         $annotationReader = new AnnotationReader();
-        $propertiesNames[$property->getName()] = ((array) $propertyAnnotations[0])["friendlyName"];
+        $reflectedClass = new \ReflectionClass($className);
+     }
+}
 </syntaxhighlight>

@@ Ligne 189 : / Ligne 189 : @@
 === Modification de la vue ===
-Enfin, les informations étant passées à la vue par le contrôleur, le tableau affichant les données relatives à la liste des entités peut se faire dynamiquement de façon convivial avec le code Twig suivant :
+Enfin, les informations étant passées à la vue par le contrôleur, le tableau affichant les données relatives à la liste des entités peut se faire dynamiquement de façon conviviale avec le code Twig suivant :
 <syntaxhighlight lang="twig" highlight="6,7,14,15">
 ...

@@ Ligne 143 : / Ligne 143 : @@
 Voici un exemple d'appel de la fonction et de passage des informations à la vue depuis un contrôleur :
-<syntaxhighlight lang="php" highlight="34,37">
+<syntaxhighlight lang="php" highlight="13,34,37">
 <?php
 // src/Controller/ApplicationController.php

← Version précédente		Version du 26 février 2020 à 17:35
Ligne 189 :		Ligne 189 :

	=== Modification de la vue ===		=== Modification de la vue ===
		+	Enfin, les informations étant passées à la vue par le contrôleur, le tableau affichant les données relatives à la liste des entités peut se faire dynamiquement de façon convivial avec le code Twig suivant :
		+	<syntaxhighlight lang="twig" highlight="6,7,14,15">
		+	...
		+	{% if applications %}
		+	<table class="table table-hover table-sm table-striped">
		+	<thead>
		+	<tr>
		+	{% for name,friendlyName in propertiesNames %}
		+	<th scope="col">{{ friendlyName }}</th>
		+	{% endfor %}
		+	</tr>
		+	</thead>
		+	<tbody>
		+	{% for application in applications %}
		+	<tr>
		+	{% for name,friendlyName in propertiesNames %}
		+	<td><a href="{{ path('application_show', {id: application.id}) }}">{{ attribute(application,name) }}</a></td>
		+	{% endfor %}
		+	</tr>
		+	{% endfor %}
		+	</tbody>
		+	</table>
		+	{% endif %}
		+	...
		+	</syntaxhighlight>
		+	Ce qui donnera l'affichage suivant :
		+	:[[Fichier:ClipCapIt-200226-183323.PNG]]

← Version précédente		Version du 26 février 2020 à 17:29
Ligne 140 :		Ligne 140 :

	=== Modification du contrôleur ===		=== Modification du contrôleur ===
		+	Comme indiqué précédemment, il est désormais possible de réaliser l'extraction des informations depuis l'appel à la fonction globale <code>getFriendlyNames()</code>.
		+
		+	Voici un exemple d'appel de la fonction et de passage des informations à la vue depuis un contrôleur :
		+	<syntaxhighlight lang="php" highlight="34,37">
		+	<?php
		+	// src/Controller/ApplicationController.php
		+	namespace App\Controller;
		+
		+	use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
		+	use Symfony\Component\Routing\Annotation\Route;
		+	use App\Entity\Application;
		+	use Doctrine\ORM\EntityManagerInterface;
		+	use Symfony\Component\HttpFoundation\Response;
		+	use Symfony\Component\Validator\Validator\ValidatorInterface;
		+	use App\Repository\ApplicationRepository;
		+
		+	use function App\getFriendlyNames;
		+
		+	/**
		+	* @Route("/application", name="application")
		+	*/
		+	class ApplicationController extends AbstractController
		+	{
		+	/**
		+	* @Route("/", name="")
		+	*/
		+	public function index(ApplicationRepository $applicationRepository)
		+	{
		+	$applications = $applicationRepository
		+	->findAll();
		+
		+	if (!$applications) {
		+	throw $this->createNotFoundException(
		+	'No application found'
		+	);
		+	}
		+
		+	$propertiesNames = getFriendlyNames('App\Entity\Application');
		+
		+	return $this->render('application/index.html.twig', [
		+	'propertiesNames' => $propertiesNames,
		+	'applications' => $applications,
		+	'controller_name' => 'ApplicationController',
		+	]);
		+	}
		+	// et le reste du contrôleur ci-dessous ...
		+	</syntaxhighlight>
		+
	=== Modification de la vue ===		=== Modification de la vue ===

@@ Ligne 114 : / Ligne 114 : @@
 === Création d'une fonction globale ===
 === Modification du contrôleur ===
 === Modification de la vue ===

← Version précédente		Version du 26 février 2020 à 17:22
Ligne 21 :		Ligne 21 :

	== Mise en oeuvre ==		== Mise en oeuvre ==
		+	La mise en oeuvre se déroulera en 5 étapes :
		+	*Création d'une classe d'annotation
		+	*Ajout d'informations dans l'entité
		+	*Création d'une fonction globale
		+	*Modification du contrôleur
		+	*Modification de la vue
		+
		+	=== Création d'une classe d'annotation ===
		+	Les annotations PHP est un projet porté par Doctrine. La documentation officielle est accessible à l'URL : https://www.doctrine-project.org/projects/doctrine-annotations/en/1.6/index.html
		+
		+	En ce qui concerne cette mise en oeuvre, il suffira de s'inspirer de la [https://www.doctrine-project.org/projects/doctrine-annotations/en/1.6/custom.html documentation sur la création de classe d'annotations personnalisée].
		+
		+	Ce qui donne, par exemple, la classe suivante :
		+	<syntaxhighlight lang="php">
		+	<?php
		+	// src/Annotations/FriendlyAnnotation.php
		+	namespace App\Annotations;
		+
		+	/**
		+	* @Annotation
		+	*/
		+	class FriendlyAnnotation
		+	{
		+	public $friendlyName;
		+	}
		+	</syntaxhighlight>
		+
		+	=== Ajout d'informations dans l'entité ===
		+	L'annotation personnalisée étant créée, il est alors possible de renseigner des champs personnalisés dans les entités.
		+
		+	Plus particulièrement, pour avoir un nom convivial pour chaque propriété, il est possible de faire ceci :
		+	<syntaxhighlight lang="php" highlight="14,22,28,34,40,46,52">
		+	<?php
		+	// src/Entity/Application.php
		+	namespace App\Entity;
		+
		+	use Doctrine\ORM\Mapping as ORM;
		+	use App\Annotations\FriendlyAnnotation;
		+
		+	/**
		+	* @ORM\Entity(repositoryClass="App\Repository\ApplicationRepository")
		+	*/
		+	class Application
		+	{
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Id")
		+	* @ORM\Id()
		+	* @ORM\GeneratedValue()
		+	* @ORM\Column(type="integer", options={"comment":"Id"})
		+	*/
		+	private $id;
		+
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Nom")
		+	* @ORM\Column(type="string", length=255, options={"comment":"Nom"})
		+	*/
		+	private $name;
		+
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Alias")
		+	* @ORM\Column(type="string", length=255, options={"comment":"Alias"})
		+	*/
		+	private $alias;
		+
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Responsable MOE")
		+	* @ORM\Column(type="string", length=255, nullable=true, options={"comment":"Responsable MOE"})
		+	*/
		+	private $applicationManager;
		+
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Responsable MOA")
		+	* @ORM\Column(type="string", length=255, nullable=true, options={"comment":"Responsable MOA"})
		+	*/
		+	private $businessManager;
		+
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Société")
		+	* @ORM\Column(type="string", length=255, options={"comment":"Société"})
		+	*/
		+	private $company;
		+
		+	/**
		+	* @FriendlyAnnotation(friendlyName="Description")
		+	* @ORM\Column(type="string", length=255, nullable=true, options={"comment":"Description"})
		+	*/
		+	private $description;
		+
		+	// et le reste des getters et setters ci-dessous ...
		+	}
		+	</syntaxhighlight>
		+
		+	=== Création d'une fonction globale ===
		+	=== Modification du contrôleur ===
		+	=== Modification de la vue ===

@@ Ligne 3 : / Ligne 3 : @@
 == Contexte ==
-Dans le cadre de la mise en place d'un simple [https://fr.wikipedia.org/wiki/CRUD CRUD] sous Symfony, il peut être nécessaire de pouvoir lister dans un tableau un ensemble d'entités.
+Dans le cadre de la mise en place d'un simple [https://fr.wikipedia.org/wiki/CRUD CRUD] sous Symfony, il peut être nécessaire de pouvoir lister dans un tableau un ensemble d'entités. Ce tableau devra donc comporter des titres de colonnes. Idéalement, ces titres doivent correspondre à la description de la propriété de l'entité.
 Par exemple, une propriété pourrait se nommer <syntaxhighlight lang="php" inline>$teamLeader</syntaxhighlight>, mais la description de cette propriété correspondrait à <code>Chef d'équipe</code>. Les propriétés des entités étant des variables PHP, il n'est pas possible de leur donner un nom convivial tel quel.