LEBONANGLE

Le site LEBONANGLE permet de déposer et de consulter des annonces sur un environnement mobile. Il est construit avec un admin Symfony et une API exposée via Api Platform.

Installation

1. Le projet doit être créé à l'aide du binaire Symfony en utilisant l'option --webapp du framework :

scoop install symfony-cli
symfony new projet-symfony-antoine-mattei --webapp # L'option '--webapp' installe tous les paquets nécessaires à la création d'une application web. L'installation sera plus lourde.
cd projet-symfony-antoine-mattei
symfony console about
symfony server:ca:install
symfony serve -d # L'option 'd' permet de lancer le processus en arrière plan.
symfony server:stop # Arrête le serveur lancé en arrière plan.

# On évite d'envoyer le dossier .idea sur le repo Git.
echo "###> JetBrains IDE ###" >> .gitignore
echo "/.idea" >> .gitignore
echo "###< JetBrains IDE ###" >> .gitignore

# Installation des dépendances :
composer require vich/uploader-bundle # Téléversement des photos

Entités

Le projet contient les entités suivantes :

(Pour voir les diagrammes sous IDE JetBrains, aller dans Settings | Languages & Frameworks | Markdown | Markdown Extensions | Mermaid)

classDiagram

class Category
Category : id - int primary not null
Category : name - string not null

class Advert
Advert : id - int primary not null
Advert : title - string not null | min = 3, max = 100
Advert : content - text not null | max = 1200
Advert : author - string not null
Advert : email - string not null
Advert : category - ManyToOne not null
Advert : price - float not null | min = 1.00, max 1 000 000.00
Advert : state - string not null
Advert : createdAt - DateTime not null
Advert : publishedAt - DateTime

class Picture
Picture : id - int primary not null
Picture : file - File | Non mappé sur la base de données
Picture : path - string not null
Picture : createdAt - DateTime not null
Picture : advert - ManyToOne delete cascade

class AdminUser
AdminUser : id - int primary not null
AdminUser : username - string not null
AdminUser : email - string not null
AdminUser : plainPassword - string not null | Non mappé sur la base de données
AdminUser : password - string not null

Loading

• Dans le fichier .env, sélectionner la base de données voulue. Choisissons MySQL obtenu avec WAMP :

CREATE USER 'esimed'@'localhost' IDENTIFIED WITH mysql_native_password AS 'esimed';
GRANT ALL PRIVILEGES ON *.* TO 'esimed'@'localhost' REQUIRE NONE WITH GRANT OPTION MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0;
CREATE DATABASE IF NOT EXISTS `esimed`;
GRANT ALL PRIVILEGES ON `esimed`.* TO 'esimed'@'localhost';

DATABASE_URL="mysql://esimed:[email protected]:3306/esimed?serverVersion=8&charset=utf8mb4"

• Création de l'entité Category (Deux fichiers créés : src\Entity\Category.php & src\Repository\CategoryRepository.php) :

symfony console make:entity

 Class name of the entity to create or update (e.g. VictoriousKangaroo):
 > Category
 
 New property name (press <return> to stop adding fields):
 > name

 Field type (enter ? to see all types) [string]:
 > string

 Field length [255]:
 > 255

 Can this field be null in the database (nullable) (yes/no) [no]:
 > no

symfony console make:migration
symfony console doctrine:migrations:migrate # peut également être écris "symfony console d:m:m"

 WARNING! You are about to execute a migration in database "esimed" that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
 > yes

• Création de l'entité Advert

symfony console make:entity

 Class name of the entity to create or update (e.g. BraveGnome):
 > Advert
 
 New property name (press <return> to stop adding fields):
 > title
 Field type (enter ? to see all types) [string]:
 > string
 Field length [255]:
 > 100
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no

 Add another property? Enter the property name (or press <return> to stop adding fields):
 > content
 Field type (enter ? to see all types) [string]:
 > text
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no

 Add another property? Enter the property name (or press <return> to stop adding fields):
 > author
 Field type (enter ? to see all types) [string]:
 > string
 Field length [255]:
 > 255
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no
 
 Add another property? Enter the property name (or press <return> to stop adding fields):
 > email
 Field type (enter ? to see all types) [string]:
 > string
 Field length [255]:
 > 255
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no
 
 Add another property? Enter the property name (or press <return> to stop adding fields):
 > category
 Field type (enter ? to see all types) [string]:
 > ManyToOne
 What class should this entity be related to?:
 > Category
 Is the Advert.category property allowed to be null (nullable)? (yes/no) [yes]:
 > no
 Do you want to add a new property to Category so that you can access/update Advert objects from it - e.g. $category->getAdverts()? (yes/no) [yes]:
 > yes
 New field name inside Category [adverts]:
 > adverts
 Do you want to automatically delete orphaned App\Entity\Advert objects (orphanRemoval)? (yes/no) [no]:
 > no

 Add another property? Enter the property name (or press <return> to stop adding fields):
 > price
 Field type (enter ? to see all types) [string]:
 > float
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no

 Add another property? Enter the property name (or press <return> to stop adding fields):
 > state
 Field type (enter ? to see all types) [string]:
 > string
 Field length [255]:
 > 255
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no

 Add another property? Enter the property name (or press <return> to stop adding fields):
 > createdAt
 Field type (enter ? to see all types) [datetime_immutable]:
 > datetime_immutable
 Can this field be null in the database (nullable) (yes/no) [no]:
 > no

 Add another property? Enter the property name (or press <return> to stop adding fields):
 > publishedAt
 Field type (enter ? to see all types) [datetime_immutable]:
 > datetime_immutable
 Can this field be null in the database (nullable) (yes/no) [no]:
 > yes

symfony console make:migration
symfony console doctrine:migrations:migrate # peut également être écris "symfony console d:m:m"

 WARNING! You are about to execute a migration in database "esimed" that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
 > yes

• Création de l'entité Picture (VichUploader)
• Création de l'entité AdminUser

Encodage des mots de passe

Lorsqu'un admin est créé ou modifié, si son plainPassword (mot de passe en clair) est renseigné, il doit être encodé et sauvé dans password grace à un listener (ou subscriber) doctrine.

Renseignement de la date de création

Lorsqu'une annonce est créée, sa date de création est automatiquement renseignée. Il en est de même pour les images.

Workflow des annonces

Les annonces sont rattachées à un workflow. Lorsqu'elles sont créées, elles sont dans le statut draft. Les admins peuvent les publier (status published ) ou les rejeter (status rejected). Une fois publiées, elles peuvent toujours être rejetées.

Quand une annonce passe du status draft à published, sa date de publication est automatiquement renseignée et un mail de notification est envoyé à l'utilisateur qui l'a créée.

Admin

Vous devez créer un admin sous Symfony. Il n'est pas possible d'utiliser un bundle d'admin (type EasyAdminBundle).

1. L'admin est accessible uniquement aux utilisateurs de type AdminUser qui s'authentifient grâce à un formulaire de connexion.

Crud AdminUser

1. Les admins peuvent lister, ajouter, mettre à jour et supprimer un utilisateur.
2. Lors de la création ou de la mise à jour, le champ password n'est pas accessible, mais le champ plainPassword l'est.
3. Un admin ne peut pas supprimer son propre compte.
4. Il doit forcément rester un admin.

Crud Category

1. Les admins peuvent lister, ajouter, mettre à jour et supprimer une catégorie.
2. Si une catégorie est rattachée à au moins une annonce, elle ne peut pas être supprimée. La liste des catégories est paginée 30 par 30.

Gestion des annonces

1. Les admins peuvent lister, consulter, publier ou rejeter une annonce.
2. Les annonces ne peuvent pas être créées, modifiées ou supprimées depuis l'admin.
3. Dans la liste, on doit connaitre le nombre de photos rattachées à l'annonce et dans la consultation, toutes les photos sont visibles. La liste des catégories est paginée 30 par 30.

API

Une API permet de récupérer et de créer des informations. Elle est basée sur le bundle Api Bundle

Category

On peut récupérer la liste des catégories ainsi qu'accéder à une seule catégorie

Advert

On peut créer / lister / accéder au détail des annonces.

Les annonces peuvent être triées par date de publication ou par prix (ASC et DESC).

Les annonces peuvent être filtrées par catégorie ainsi que par prix (entre min et max)

Picture

On peut créer / lister / accéder au détail des images. Les images sont créées via l'API avant les annonces (en envoyant le fichier) et l'annonce reçoit la liste des images téléchargées lors de la création (c'est à ce moment-là que le lien est fait entre annonce et image en base de données).

Notification

Lorsqu'une annonce est créée, une notification par mail est envoyée à tous les AdminUser.

La notification contient 3 boutons : un permettant d'envoyer sur la fiche de consultation dans l'admin, un second permettant de publier l'annonce et un troisième de rejeter l'annonce.

Test

L'API doit être intégralement testée. Vous pouvez voir comment tester une API dans la documentation d'API platform.

L'accès mobile

L'API sera consommé par une interface mobile utilisant la technologie de votre choix à partir du moment où elle a été étudiée en cours.

Elle permet de lister et de filtrer les annonces publiées comme décrit dans la partie API des annonces.

Elle offre également la possibilité de créer une annonce et les images rattachées.

La création d'une annonce se fait sans compte utilisateur. Elles ne peuvent pas être modifiées.

Commandes (bonus)

Vous devez créer les commandes symfony suivantes :

• Une commande permettant de supprimer toutes les annonces rejetées, créées il y a X jours (X étant un argument de la commande)
• Une commande permettant de supprimer toutes les annonces publiées il y a X jours (X étant un argument de la commande). Ne pas se fier à la date de création, mais bien à celle de publication.
• Une commande permettant de supprimer toutes les images non rattachées à une annonce créées il y a plus de X jours (X étant un argument de la commande).