Séance 10 : VueJs et ApiPlatform (1)

Afficher les fournisseurs

Vous allez ajouter une nouvelle vue pour afficher la liste des fournisseurs. Pour cela, en vous basant sur les séances précédentes, suivez les étapes suivantes :

Créer une vue FournisseursView.vue dans le dossier src/views
Ajouter la route associée
Ajouter le lien dans le menu
Ajouter dans FournisseursView.vue, une variable data qui contiendra la liste des fournisseurs, et une méthode onMounted qui appellera l'API pour récupérer la liste des fournisseurs. Regardez dans ApiPlatform, l'URL à utiliser.
Affichez les fournisseurs : Libellé et adresse. Attention, l'adresse pourrait être vide/null, il faut donc vérifier avant d'afficher l'adresse.

Il est assez probable (si vous avez la version 4 d'ApiPlatform), que la ville se résume à une IRI du type : /api/adresse/1. C'est normal ! ApiPlatform V4 ne diffuse plus les données d'une relation de manière automatique.

Configurer ApiPlatform pour intégrer les données d'une relation

Il faut paramétrer le contexte de normalisation, c'est à dire les données envoyées dans le Json ()

Concrétement nous devons dans notre fichier Fournisseur.php (de notre partie back) définir le contexte et préciser l'ensemble des propriétés (ou méthodes) à intégrer, ainsi que dans la relation Adresse.

Le fichier Fournisseur.php deviendrait donc :

// le code existant
#[ApiResource(
    normalizationContext: ['groups' => ['fournisseur:read']],
)]
class Fournisseur
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    #[Groups(['fournisseur:read'])]
    private ?int $id = null;

    #[ORM\Column(length: 255)]
    #[Groups(['fournisseur:read'])]
    private ?string $libelle = null;

    #[ORM\ManyToOne(inversedBy: 'fournisseurs', cascade: ['persist'])]
    #[Groups(['fournisseur:read'])]
    private ?Adresse $adresse = null;
//le reste du code

où

normalizationContext: ['groups' => ['fournisseur:read']],)] : permet de définir les "groupes" pris en compte dans la transformation en json (normalisation). Un groupe étant une chaine de caractère lire pour identifier les éléments à prendre en compte. Plusieurs groupes peuvent être définis
#[Groups(['fournisseur:read'])] : pour définir les propriétés ou méthodes à intégrer. Attention aux choix et à ne pas créer des références circulaires

Il faut faire de même sur Adresse.php avec les champs que vous souhaitez intégrer

Une référence circulaire est un parcours infini sur des entités lors du processus de normalisation. Exemple un fournisseur à une adresse, les adresses on des fournisseurs, un fournisseur à une adresse, ... Il convient donc d'être vigilant aux éléments mis dans un groupe lors de la normalisation.

Ajouter un fournisseur

Vous allez maintenant ajouter un formulaire pour ajouter un nouveau fournisseur. Dans un premier temps, nous allons ajouter simple le libellé du fournisseur.

Pour des raisons de simplicités, nous allons utiliser un formulaire HTML classique, et non un formulaire avec VueJs. Pour cela, vous allez créer un formulaire HTML dans la vue Fournisseurs.vue. Ce formulaire contiendra un champ input pour le libellé du fournisseur, et un bouton pour envoyer le formulaire.

On associera un v-model sur le champ input pour récupérer la valeur du champ (nommé libelle). On ajoutera un @click sur le formulaire pour intercepter l'événement de clic sur le bouton du formulaire (on pourrait le faire avec un @submit).

La méthode appelée (ajouter par exemple) devra récupérer la valeur du champ libellé, et appeler l'API pour ajouter le fournisseur.

De nouveau regarder dans ApiPlatform, l'URL à utiliser. Cette requête doit être en POST, et le corps de la requête doit contenir le libellé du fournisseur.

Avec fetch cela pourrait ressembler à ça :

await fetch('http://127.0.0.1:8000/api/fournisseurs', {
    method: 'POST',
    headers: {
       'Content-Type': 'application/ld+json'
    },
    body: JSON.stringify({
       libelle: libelle.value
    })
})

avec axios :

await axios.post('http://127.0.0.1:8000/api/fournisseurs', {
    libelle: libelle.value
})

Exercice

Mettre en place le formulaire et la méthode pour ajouter un fournisseur.

Rafraîchir la liste des fournisseurs

Comme vous pouvez le constater, le fournisseur est ajouté dans la base de données, mais ce n'est pas visible dans la liste des fournisseurs. Pour cela, il faut rafraîchir la liste des fournisseurs.

Pour cela, une fois le fournisseur ajouté, il faudrait actualiser la liste des fournisseurs. On pourrait reprendre un code similaire à celui de la méthode onMounted pour récupérer la liste des fournisseurs. Mais il y a un problème : la méthode onMounted est appelée une seule fois, au chargement de la page. Il faut donc trouver une autre solution.

Pour éviter de copier/coller du code et de le dupliquer, on va écrire une fonction qui récupère la liste des fournisseurs, et qui sera appelée par la méthode onMounted et par la méthode qui ajoute un fournisseur, et peut être à d'autres instants.

async function getFournisseurs {
    // code pour récupérer la liste des fournisseurs
}

On peut maintenant appeler cette fonction dans la méthode onMounted et dans la méthode qui ajoute un fournisseur.

onMounted(async () => {
  getFournisseurs()
})

Exercice

Mettre en place le rafraîchissement de la liste des fournisseurs lors de l'ajout d'un nouveau fournisseur.

Ajouter l'adresse

Maintenant que vous avez mis en place l'ajout d'un fournisseur, vous allez ajouter l'adresse du fournisseur.

Pour cela, vous allez modifier le formulaire HTML pour ajouter un champ pour l'adresse. Vous allez également modifier la méthode qui ajoute un fournisseur pour envoyer l'adresse.

L'ajout de l'adresse est un peu particulier, car c'est une relation entre Fournisseur et Adresse. Mais si vous regardez dans ApiPlatform, vous verrez que l'adresse peut être envoyée dans le corps de la requête, directement dans l'objet fournisseur.

{
  "libelle": "string",
  "adresse": {
    "rue": "string",
    "codepostal": "string",
    "ville": "string",
    "fournisseurs": [
      "string"
    ]
  },
  "articles": [
    {
      "designation": "string",
      "description": "string",
      "quantite": 0,
      "prix": 0,
      "fournisseur": "string"
    }
  ]
}

Vous auriez même la possibilité d'ajouter un article. Mais pour l'instant, nous allons juste ajouter l'adresse.

Nous devons donc envoyer un objet json ressemblant à ça :

{
  "libelle": "string",
  "adresse": {
    "rue": "string",
    "codepostal": "string",
    "ville": "string"
  }
}

Exercice

Ajouter les champs pour l'adresse dans le formulaire HTML (rue, codepostal, ville), déclarer les variables dans la vue, et les associer au v-model.
Modifier la méthode qui ajoute un fournisseur pour envoyer l'adresse.

PreviousSéance 9 : ApiPlatform NextSéance 11 : VueJs et ApiPlatform (2)

Last updated 2 months ago

Afficher les fournisseurs

Vous allez ajouter une nouvelle vue pour afficher la liste des fournisseurs. Pour cela, en vous basant sur les séances précédentes, suivez les étapes suivantes :

Créer une vue FournisseursView.vue dans le dossier src/views
Ajouter la route associée
Ajouter le lien dans le menu
Ajouter dans FournisseursView.vue, une variable data qui contiendra la liste des fournisseurs, et une méthode onMounted qui appellera l'API pour récupérer la liste des fournisseurs. Regardez dans ApiPlatform, l'URL à utiliser.
Affichez les fournisseurs : Libellé et adresse. Attention, l'adresse pourrait être vide/null, il faut donc vérifier avant d'afficher l'adresse.

Configurer ApiPlatform pour intégrer les données d'une relation

Il faut paramétrer le contexte de normalisation, c'est à dire les données envoyées dans le Json ()

Le fichier Fournisseur.php deviendrait donc :

// le code existant
#[ApiResource(
    normalizationContext: ['groups' => ['fournisseur:read']],
)]
class Fournisseur
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    #[Groups(['fournisseur:read'])]
    private ?int $id = null;

    #[ORM\Column(length: 255)]
    #[Groups(['fournisseur:read'])]
    private ?string $libelle = null;

    #[ORM\ManyToOne(inversedBy: 'fournisseurs', cascade: ['persist'])]
    #[Groups(['fournisseur:read'])]
    private ?Adresse $adresse = null;
//le reste du code

où

normalizationContext: ['groups' => ['fournisseur:read']],)] : permet de définir les "groupes" pris en compte dans la transformation en json (normalisation). Un groupe étant une chaine de caractère lire pour identifier les éléments à prendre en compte. Plusieurs groupes peuvent être définis
#[Groups(['fournisseur:read'])] : pour définir les propriétés ou méthodes à intégrer. Attention aux choix et à ne pas créer des références circulaires

Il faut faire de même sur Adresse.php avec les champs que vous souhaitez intégrer

Ajouter un fournisseur

Vous allez maintenant ajouter un formulaire pour ajouter un nouveau fournisseur. Dans un premier temps, nous allons ajouter simple le libellé du fournisseur.

La méthode appelée (ajouter par exemple) devra récupérer la valeur du champ libellé, et appeler l'API pour ajouter le fournisseur.

De nouveau regarder dans ApiPlatform, l'URL à utiliser. Cette requête doit être en POST, et le corps de la requête doit contenir le libellé du fournisseur.

Avec fetch cela pourrait ressembler à ça :

await fetch('http://127.0.0.1:8000/api/fournisseurs', {
    method: 'POST',
    headers: {
       'Content-Type': 'application/ld+json'
    },
    body: JSON.stringify({
       libelle: libelle.value
    })
})

avec axios :

await axios.post('http://127.0.0.1:8000/api/fournisseurs', {
    libelle: libelle.value
})

Exercice

Mettre en place le formulaire et la méthode pour ajouter un fournisseur.

Rafraîchir la liste des fournisseurs

async function getFournisseurs {
    // code pour récupérer la liste des fournisseurs
}

On peut maintenant appeler cette fonction dans la méthode onMounted et dans la méthode qui ajoute un fournisseur.

onMounted(async () => {
  getFournisseurs()
})

Exercice

Mettre en place le rafraîchissement de la liste des fournisseurs lors de l'ajout d'un nouveau fournisseur.

Ajouter l'adresse

Maintenant que vous avez mis en place l'ajout d'un fournisseur, vous allez ajouter l'adresse du fournisseur.

Pour cela, vous allez modifier le formulaire HTML pour ajouter un champ pour l'adresse. Vous allez également modifier la méthode qui ajoute un fournisseur pour envoyer l'adresse.

{
  "libelle": "string",
  "adresse": {
    "rue": "string",
    "codepostal": "string",
    "ville": "string",
    "fournisseurs": [
      "string"
    ]
  },
  "articles": [
    {
      "designation": "string",
      "description": "string",
      "quantite": 0,
      "prix": 0,
      "fournisseur": "string"
    }
  ]
}

Vous auriez même la possibilité d'ajouter un article. Mais pour l'instant, nous allons juste ajouter l'adresse.

Nous devons donc envoyer un objet json ressemblant à ça :

{
  "libelle": "string",
  "adresse": {
    "rue": "string",
    "codepostal": "string",
    "ville": "string"
  }
}

Exercice

Ajouter les champs pour l'adresse dans le formulaire HTML (rue, codepostal, ville), déclarer les variables dans la vue, et les associer au v-model.
Modifier la méthode qui ajoute un fournisseur pour envoyer l'adresse.