Skip to content

Latest commit

 

History

History
310 lines (217 loc) · 10.6 KB

README.md

File metadata and controls

310 lines (217 loc) · 10.6 KB
Raw

D3l

D3l est un framework léger qui permet de faire des sites en PHP. Il dispose des fonctionnalités suivantes:

  • Middleware
  • Moteur de templating
  • Routage automatique
  • Migration de la base de données
  • Gestion de la base de données simplifiée
  • Simplification des appels à des API externes

Lancer le projet

Le projet de test est disponible et fonctionne via 2 commande:

Tout d'abord, lancer les docker:

docker compose -f docker-compose.yml up #dans le dossier du projet

Puis, creer la base de donnée:

bash run.sh db:init

Middleware

Les middlewares sont des fonctions qui sont exécutées avant ou après une requête.

  • Étape 1 : Créez une instance dux middleware

Le fichier index.php à la racine représente le point d'entrée de l'application. On construit une file de middlewares à l'aide de la classe MiddlewareQueue et on l'injecte dans l'application.

// Create a middleware queue
$middlewareQueue = new MiddlewareQueue();

// Add middlewares to the queue
$middlewareQueue->addMiddleware(new CorsMiddleware());
$middlewareQueue->addMiddleware(new ExceptionsMiddleware());
$middlewareQueue->addMiddleware(new RoutingMiddleware());

// Handle the request with the middlewares
$response = $middlewareQueue->handle($_REQUEST);
  • Étape 2 : Créez vos middlewares

Créez des classes qui étendent la classe Middleware et implémentez la méthode handle. Par exemple, ExceptionsMiddleware ressemble à ceci :

class ExceptionsMiddleware extends Middleware
{
    public function handle($request, $nextMiddleware)
    {
        try { // Try to handle the request with the next middleware
            $response = $nextMiddleware->handle($request);
            return $response;
            
        } catch (RouteNotFoundException $e) { // Catch route not found exceptions
            http_response_code($e->getCode());
        }
        
        catch ( \Exception $e ) { // Catch all other exceptions
            http_response_code(500);
        }
    }
}

Moteur de templating

  • Étape 1 : Créez une instance du moteur de template
// Incluez votre classe de moteur de template
require 'Template.php';

// Créez une instance de votre moteur de template
$templateEngine = new Template();
  • Étape 2 : Assignez des données aux modèles

Utilisez la méthode assign pour associer des données aux variables que vous souhaitez afficher dans vos modèles. Par exemple :

$templateEngine->assign('pageTitle', 'Mon site web');
$templateEngine->assign('name', 'John');

Ou en passant une variable de contexte au constructeur de la classe

$templateEngine = new Template([
    'pageTitle' => 'Mon site web',
    'name' => 'John'
]);
  • Étape 3 : Chargez et affichez un modèle

Utilisez la méthode render pour charger et afficher un modèle. Vous pouvez passer le nom du fichier du modèle en argument. Assurez-vous que le fichier existe dans le répertoire de modèles spécifié.

$output = $templateEngine->render('template.html');
  • Étape 4 : Afficher le résultat

La sortie générée par le moteur de template est stockée dans la variable $output. Vous pouvez l'afficher sur la page web en utilisant echo.

echo $output;
  • Exemple complet
require 'TemplateEngine.php';

// Créez une instance de votre moteur de template
$templateEngine = new TemplateEngine();

// Assignez des données aux modèles
$templateEngine->assign('pageTitle', 'Mon site web');
$templateEngine->assign('name', 'John');

// Chargez et affichez un modèle
$output = $templateEngine->render('template.html');

// Affichez la sortie générée
echo $output;
  • Étape 5 : Créez vos modèles

Créez des fichiers HTML avec les placeholders {{ ... }} pour les données que vous avez assignées. Par exemple, template.html pourrait ressembler à ceci :

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{ pageTitle }}</title>
</head>
<body>
    <h1>Hello {{ name }}</h1>
</body>
</html>

Routage automatique

Le routage dynamique se fait par le biais d'annotations / attributs. Par exemple:

#[Route('/', name: 'index', methods: ['GET'])]
public function index(){

Le premier paramètre est le chemin / URI, le deuxième est le nom et enfin la méthode. Il est possible qu'une route réponde la même chose pour différentes méthodes.

#[Route('/id/{id<\d+>}', name: 'id', methods: ['GET'])]
public function id($param){

On peut également donner des regex pour donner de quel type doit et va être le paramètre. Dans notre exemple, la valeur doit être un entier, sinon on n'appelle pas la fonction et dans le cas où celle-ci est appelée, alors $param['id'] sera de type entier.

Note: Pour l'instant seuls 3 types sont supportés; integer,float,string. Note 2: Les données posts ne sont pas gérer, c'est à la liberté de l'utilisateur.

En cas de route non trouvée, une exeception est levée dans le middleware RoutingMiddleware et est attrapée par le middleware ExceptionsMiddleware qui renvoie une erreur 404.

Il est possible de modifier la page d'erreur 404 en modifiant le fichier 404.html dans le dossier templates.

Base de données

Initialisation

La configuration docker par défaut contient un container postgresql préconfiguré.

Un fichier model avec sa classe correspond à une table de la base de données. Une variable correspond à une colonne.

Une fois les modèles créés, il suffit d'exécuter cette commande à la racine du projet :

bash run.sh db:init

Migration

Durant le déroulement du projet, il est possible que la base de données évolue. Pour cela, il faut créer une migration.

Dans un premier temps, modifier les fichiers models correspondants. Ensuite, exécuter la commande suivante :

bash run.sh db:migrate

Cette commande crée la migration et l'exécute directement dans la base.

Si vous ne voulez pas faire ces 2 actions en une fois, vous pouvez utiliser les arguments --create et --execute.

La création d'une migration crée 2 fichiers :

  • le premier est un fichier SQL qui contient les requêtes à exécuter.
  • le second est un fichier JSON qui contient les informations de la migration.

Si vous créez une migration sans l'exécuter, vous pouvez modifier le fichier SQL mais cela implique de modifier le fichier JSON en conséquence. Cette manipulation n'est pas recommandée car une erreur peut être irréversible.

L'ORM

Notre framework inclut un ORM minimal, celui-ci permet de faire des requêtes très basiques sans faire de SQL. Pour cela, le controleur doit étendre le D3LController et préciser le nom de la table liée. De cette manière les update, delete et les save automatiquement.

Note: les jointures et autres requêtes par champs n'ont pas été créées mais peuvent être le sujet d'une amélioration future.

Exemple:

class UserController extends \D3LController {
    ...

    #[Route('/delete/{id<\d+>}', name: 'delete', methods: ['GET'])]
    function deleteReq($id) {
        header('Content-Type: application/json; charset=utf-8');
        $ret = $this->delete($id['id']);
        echo json_encode(["deleted" => $ret]);
    }

Dans notre cas on va récupérer l'id via le module de routing vu précédemment et supprimer l'utilisateur dont l'id vaut la valeur en paramètre.

Simplification des appels à des API externes

Classic API access

Les méthodes classiques de requêtage d'API sont utilisables via D3LApiService.

  • GetRequest(link, format)
Type Documentation
Link Lien de l'API après utilisation du Builder
Format Format de retour de l'api (Raw, XML, JSON)
  • GetPost(link, objet)
Type Documentation
Link Lien de l'API après utilisation du Builder
Object Objet PHP
  • GetDelete(link, objet)
Type Documentation
Link Lien de l'API après utilisation du Builder
Object Objet PHP
  • GetPut(link, objet)
Type Documentation
Link Lien de l'API après utilisation du Builder
Object Objet PHP

JWT API access

Les méthodes de requêtage d'API utilisant une authentication JWT sont utilisables via D3LApiServiceJWTBearer.

  • SGet(link, format, login, password, authenticationLink)
Type Documentation
Link Lien de l'API après utilisation du Builder
Format Format de retour de l'api (Raw, XML, JSON)
Login Login API
Password Password API
Authentication Link Lien d'authentication pour le jeton
  • SPost(link, object, login, password, authenticationLink)
Type Documentation
Link Lien de l'API après utilisation du Builder
Objet Objet PHP
Login Login API
Password Password API
Authentication Link Lien d'authentication pour le jeton
  • SDelete(link, object, login, password, authenticationLink)
Type Documentation
Link Lien de l'API après utilisation du Builder
Objet Objet PHP
Login Login API
Password Password API
Authentication Link Lien d'authentication pour le jeton
  • SPut(link, object, login, password, authenticationLink)
Type Documentation
Link Lien de l'API après utilisation du Builder
Objet Objet PHP
Login Login API
Password Password API
Authentication Link Lien d'authentication pour le jeton