Installation #

Leaf 3 a été conçu pour être adopté de manière incrémentielle. Cela signifie qu'il peut être intégré dans un projet de plusieurs façons, en fonction des besoins.

Il y a quatre façons principales d'ajouter le Leaf PHP à un projet :

1. Utiliser Leaf CLI pour monter un projet [RECOMMANDÉ].
2. Télécharger Leaf via Composer
3. Utiliser Leaf skeleton pour démarrer rapidement un projet
4. Télécharger le dépôt Leaf

Notes de version #

Dernière version de Leaf 3 :

Notes détaillées à propos de cette version disponibles sur GitHub.

Leaf CLI #

Leaf fournit une CLI officielle pour créer et gérer rapidement vos applications Leaf. Il suffit de quelques secondes pour être opérationnel avec votre application. Consultez la documentation sur le CLI de Leaf pour plus de détails.

leaf create <project-name> --v3

Pour installer des modules, utilisez cette syntaxe :

leaf install cors

Et pour lancer votre application Leaf :

leaf serve

Composer #

Vous pouvez également créer un nouveau projet Leaf 3 en utilisant Composer :

# Dernière version stable (v3)
$ composer require leafs/leaf

# Version 3 dev
$ composer require leafs/leaf dev-v3.x-dev

Après l'installation de Leaf, you allez devoir créer le fichier index.php, qui sera le point d'entrée de votre application.

<?php

require __DIR__ . "/vendor/autoload.php";

$app = new Leaf\App;

$app->get("/", function () use($app) {
  $app->response()->json(["message" => "Hello World!"]);
});

$app->run();

<?php

require __DIR__ . "/vendor/autoload.php";

app()->get("/", function () {
  response()->json(["message" => "Hello World!"]);
});

app()->run();

Vous pourriez avoir envie de lire la partie concernant la réécriture d'URL.

GitHub #

Vous pouvez aussi cloner le dépôt de Leaf 3.

Après avoir téléchargé le dépôt, vous devez créer un autoloader.

Exemple : autoloader.php

<?php
spl_autoload_register(function ($class) {
  $file = str_replace('\\', '/', $class);

  if (!file_exists("leaf/src/$file.php")) return;

  require "leaf/src/$file.php";
});

L'autoloader vous permettra d'utiliser les fichiers Leaf sans avoir à les require ou les include au préalable. Ainsi, l'utilisation de Leaf\App chargera leaf\src\App.php.

Cette opération est requise seulement si vous téléchargez le dépôt.

Maintenant, tout ce que vous avez à faire est de créer votre fichier index.php, d'installer les dépendances de Leaf (modules de base) et d'inclure votre autoloader comme ceci :

<?php

require __DIR__ . "leaf/vendor/autoload.php";
require __DIR__ . "autoloader.php";

<?php

require __DIR__ . "leaf/vendor/autoload.php";
require __DIR__ . "autoloader.php";
require __DIR__ . "leaf/src/functions.php";

Bien que cette méthode soit un peu plus compliquée, elle vous donne un contrôle total sur Leaf et son fonctionnement puisque vous aurez l'accès au code source. Vous pouvez directement modifier Leaf pour qu'il se comporte comme bon vous semble. Ceci dit, si ce n'est pas utile pour vous, nous vous recommandons d'installer Leaf avec Composer, ou si vous souhaitez une installation de base, vous pouvez suivre l'une des méthodes ci-dessous.

Leaf Skeleton #

Leaf Skeleton est un boilerplate officiel de Leaf qui contient une installation par défaut avec une configuration et une installation MVC optionnelles.

leaf create <project-name> --skeleton --v3

La principale installation de Leaf Skeleton se fait via Composer :

composer create-project leafs/skeleton <project-name>