Utilisation
Le fonctionnement de base de QuickModels est relativement simple et assez similaire à bien d'autres solutions de ce type.
Il s'agit donc, dans un premier temps, de mémoriser l'ensemble des valeurs et données à afficher grâce au langage Php, c'est ce script qui sera ensutie appelé pour afficher la page finale, puis, ensuite, il suffira d'intégrer, dans un simple fichier Html, qui sera en définitive le modèle, les balises reconnues par QM correspondantes aux données qu'on souhaite afficher.
QuickModels s'utilise donc en deux étapes :
- Code Php : configuration et mémorisation des variables et valeurs à utiliser ;
- Code Html : création du modèle avec le jeu de balises propres au programme.
1. Code Php
Il faut commencer par intégrer QM au projet par une simple inclusion Php (bien s'assurer que le chemin d'accès au programme est correct) :
<?php
include('quickmodels.php');
?>
Ensuite, il faut créer une instance du programme dans une variable (le nom de celle-ci est libre, ici "qm" reprend l'abréviation du programme) :
<?php $qm = new quickmodels(); ?>
Voilà, QM est prêt à être utilisé, de manière très simple, avec seulement deux méthodes principales : $qm->set et $qm->get.
La méthode $qm->set permet de mémoriser les données à afficher, alors que la méthode $qm->get lance la construction de la page Html pour l'afficher.
Voyons tout ça de plus près.
Imaginons que nous désirons afficher la valeur d'une varaible dans notre modèle, il faut tout d'abord la mémoriser dans QM, avec la méthode $qm->set, de la manière suivante :
<?php
$qm->set('salut', 'Bonjour à tous !');
?>
Ici, 'salut' correspond au nom de la variable, qui sera ensuite utilisée dans le modèle et, 'Bonjour à tous !', est le texte que nous désirons afficher.
Tous les contenus de type texte, et même Html, sont mémorisables, il faut juste faire attention à échapper (protéger) les appostrophes ou gillemets, avec un anti-slash "\", pour éviter les éventuelles erreurs d'interprétation du code Php, par exemple :
<?php
$qm->set('salut', 'Bonjour à toute l\'association !');
?>
Ici "l'association" comporte une appostrophe qui pourrait poser problème se elle n'était pas protégée avec un anti-slash.
<?php
$qm->set("<p class=\"citation\">Bonjour à toute l'association !</p>");
?>
Ici, en revanche, comme le caractèr de délimitation de la chaîne est le guillemet, l'appostrophe du mot "l'association" ne pose pas de soucis, mais les gillemets de l'attribut Html "class" doivent du coup être protégés par des anti-slash.
Nous voilà prêts à afficher notre beau texte, il suffit d'appeler la méthode $qm->get pour que notre page Html s'affiche, en indiquant juste le chemin d'accès, relatif ou absolu, du modèle à utiliser :
<?php
$qm->get('chemin/du/modele_qm.html');
?>
Après les traitemensts de QM, il est souvent probable que le code Html résultant comporte des retours à la linge en double ou plus, ainsi que des espaces ou des tabulations en trop, il est donc possible de demaner à QM de nettoyer le code en ajoutant un argument à la méthode $qm->get, qui doit être une valeur booléenne vraie (true ou 1) :
<?php
$qm->get('chemin/du/modele_qm.html', true);
?>
Il est également possible de demander à QM de nettoyer un caractère en particulier, en ajoutant encore un argument à la méthode $qm->get, dans l'exemple suivant il s'agit de nettoyer tous les tirets bas qui sont en double ou plus :
<?php
$qm->get('chemin/du/modele_qm.html', false, "_");
?>
Le code entier de notre fichier Php, que nous nommerons "test_qm.php", est le suivant :
<?php
include('quickmodels.php'); // inclusion de QM
$qm = new quickmodels(); // création d'une nouvelle instance
$qm->set('salut', 'Bonjour à tous !'); // mémorisaton d'une donnée
// création et affichage de la page Html suivant le modèle indiqué
echo $qm->get('chemin/du/modele_qm.html', 1);
?>
Mais avant que quoi que ce soit ne s'affiche, nous devons créer ce modèle Html et y placer les balises nécessaires à l'affichage de nos données.
2. Code Html
Un modèle QM n'est autre chose qu'une page Html classique (en général, d'autres possibilités existent, nous les aborderons plus loin), avec seulement, à l'endroit nécessaire, des balises reconnues par QM.
Continuons avec notre exmple simple. Nous désirons donc afficher notre message "salut", voici un code Html basique pour illustrer la technique :
<html>
<head>
<title>Salut</title>
</head>
<body>
<div>
<p><!--{salut}--></p>
</div>
</body>
</html>
Comme on peut le constater, les balises propres à QM sont sous la forme des simples commentaires Html, c'est à dire, entourés des balises <!-- et -->.
Selon ce que l'on souhaite afficher, les balises des commentaires Html son complétés avec des accolades (pour les variables notamment), des crochets (pour les inclusions), des parethèses (pour les blocs conditionnels) ou des caracètes supérieur-inférieur (pour les boucles), nous verrons les particularités de ces différentes syntaxes plus loin.
Pour les variables, il faut les entourer d'accolades, ouvrante "{" au début et fermante "}" à la fin, en prennant bien soin qu'elles soient toujours collés aux balises des commentaires Html ou séparées seulement d'une espace, sans aucun autre type de contenu.
Par exemple, les balises suivantes ne seront pas reconnues et interprétées par QM :
<!-- {salut}-->
<!--{salut} Pierre -->
<!--{ salut } -->
<!--Coucou {salut} -->
En revanche, les syntaxes correctes, et donc supportées par QM, sont les suivantes :
<!--{salut}-->
<!-- {salut}-->
<!--{salut} -->
<!-- {salut} -->
Une fois notre modèle enregistré, à l'exécution du code du fichier Php "test_qm.php", nous obtiendros la page Html suivante :
<html> <head> <title>Salut</title> </head> <body> <div> <p>Bonjour à tous !</p> </div> </body> </html>
Rendez-vous sur les différents exemples pour bien visualiser et comprendre le mode de fonctionnement de QuickModels.
QuickModels - 0.02356 - sico