4D Doc Center : Balises HTML 4D

4D v14.3

Balises HTML 4D

Le serveur Web de 4D fournit diverses balises HTML spécifiques à 4D, permettant d'insérer des références à des expressions ou variables 4D, ou différents types de traitements, à l'intérieur des pages HTML envoyées par le serveur Web 4D, par exemple à l'aide des commandes WEB ENVOYER FICHIER et WEB ENVOYER BLOB. Ces pages sont appelées pages semi-dynamiques.

Ces balises doivent être insérées sous forme de commentaires HTML ( en code HTML). La plupart des éditeurs HTML proposent des fonctions facilitant l'insertion de commentaires dans les pages statiques.

Les balises HTML 4D disponibles sont les suivantes :

4DTEXT, pour insérer des variables et expressions 4D en tant que texte
4DHTML, pour insérer du code HTML
4DSCRIPT, pour exécuter une méthode 4D
4DINCLUDE, pour insérer une page HTML dans une autre page
4DBASE, pour modifier le dossier par défaut utilisé par la balise 4DINCLUDE
4DIF, 4DELSE, 4DELSEIF et 4DENDIF, pour insérer des conditions dans le code HTML
4DLOOP et 4DENDLOOP, pour insérer des boucles dans le code HTML

Traitement des balises HTML 4D

L’analyse du contenu des pages semi-dynamiques envoyées par 4D s’effectue au moment de l’appel à WEB ENVOYER FICHIER (.htm, .html, .shtm, .shtml), WEB ENVOYER BLOB (blob de type text/html), WEB ENVOYER TEXTE et lors de l'envoi de pages appelées via des URLs. Dans ce dernier cas, à des fins d'optimisation, les pages suffixées “.htm” et “.html” ne sont PAS analysées. Pour “forcer” l’analyse des pages HTML dans ce cas, vous devez les suffixer “.shtm” ou “.shtml” (par exemple http://www.server.com/dir/page.shtm). Un exemple d'utilisation de ce type de page est fourni dans la description de la routine WEB LIRE STATISTIQUES.

En interne, l'analyseur travaille avec des chaînes utf-16, mais les données à analyser peuvent avoir été encodées différemment. Lorsque les balises contiennent du texte (par exemple 4DHTML), 4D convertit les données si nécessaire en fonction de leur provenance et des informations disponibles (charset). Voici un tableau récapitulatif des cas dans lesquels 4D analyse les balises contenues dans les pages HTML ainsi que les conversions éventuellement effectuées :

Action	Analyse du contenu des pages envoyées	Jeu de caractères utilisé pour l'analyse des balises
Extensions des pages (cas général) :
.htm, .html, .shtm, .shtml (pages HTML)	X
.xml, .xsl (pages XML)	X
.wml (pages WML)	X
Pages appelées par des URLs	X, sauf pages suffixées “.htm” ou “.html”	Utilisation du charset passé en paramètre de l'en-tête "Content-Type" de la page. A défaut, recherche d'une balise META-HTTP EQUIV avec un charset. Sinon, utilisation du jeu de caractères par défaut du serveur HTTP
Commande WEB ENVOYER FICHIER	X	Utilisation du charset passé en paramètre de l'en-tête "Content-Type" de la page. A défaut, recherche d'une balise META-HTTP EQUIV avec un charset. Sinon, utilisation du jeu de caractères par défaut du serveur HTTP
Commande WEB ENVOYER TEXTE	X	Pas de conversion nécessaire
Commande WEB ENVOYER BLOB	X, si le BLOB est du type “text/html”	Utilisation du charset défini dans l'en-tête "Content-Type" de la réponse. Sinon, utilisation du jeu de caractères par défaut du serveur HTTP.
Inclusion par la balise <!--#4DINCLUDE-->	X	Utilisation du charset passé en paramètre de l'en-tête "Content-Type" de la page. A défaut, recherche d'une balise META-HTTP EQUIV avec un charset. Sinon, utilisation du jeu de caractères par défaut du serveur HTTP
Commande TRAITER BALISES 4D	X	Données Texte : pas de conversion. Données BLOB : conversion automatique depuis le jeu de caractères Mac-Roman par compatibilité

En vue d’une exploitation par 4D, un commentaire HTML doit toujours être de la forme . Attention, certains éditeurs HTML ajoutent automatiquement d’autres informations au sein d’un commentaire, ce qui peut entraîner des erreurs d’analyse.

La présence d’autres commentaires HTML (par exemple ) est toutefois possible.

Si un commentaire , un texte de la forme “ attendu” sera inséré et l’analyse sera interrompue à ce niveau (la page sera tout de même envoyée pour indiquer l’erreur).

Il est possible d’imbriquer les différents types de commentaires. Voici par exemple une structure HTML parfaitement envisageable :

<HTML>
...
<BODY>
<!--#4DSCRIPT/PRE_PROCESS-->         (Appel de méthode)
<!--#4DIF (mavar=1)-->               (Si condition)
   <!--#4DINCLUDE banner1.html-->   (Insertion d’une sous page)
<!--#4DENDIF-->                     (Fin de si)
<!--#4DIF (mavar=2)-->
   <!--#4DINCLUDE banner2.html-->
<!--#4DENDIF-->

<!--#4DLOOP [TABLE]-->               (Boucle sur la sélection courante)
<!--#4DIF ([TABLE]ValNum>10)-->         (Si [TABLE]ValNum>10)
   <!--#4DINCLUDE subpage.html-->   (Inclusion d'une sous page)
<!--#4DELSE-->                     (Sinon)
   <B>Valeur : <!--#4DTEXT [TABLE]ValNum--></B><BR>
                              (Affichage d’un champ)
<!--#4DENDIF-->
<!--#4DENDLOOP-->                  (Fin de boucle)
</BODY>
</HTML>

Balise 4DTEXT

Syntaxe :  ou

La balise  vous permet d’insérer une référence à une variable ou à une expression 4D à tout endroit d'une page HTML. Par exemple, si vous écrivez :
<P>Bienvenue sur !</P>
La valeur de la variable 4D vtNomSite sera insérée dans la page HTML lors de son envoi. Cette valeur est insérée sous forme de texte simple, les caractères HTML spéciaux tels que "<" sont automatiquement échappés.

Il est aussi possible d’insérer des expressions 4D à l’aide de la balise 4DTEXT. Vous pouvez par exemple insérer directement le contenu d’un champ (), un élément de tableau () ou une méthode retournant une valeur ().

La conversion de l’expression obéit aux mêmes règles que la conversion d’une variable. En outre, l’expression doit satisfaire aux règles de syntaxe de 4D.

Note : L'exécution d'une méthode 4D avec 4DTEXT est soumise à la valeur de l’attribut “Disponible via les balises HTML et URLs 4D (4DACTION...)” défini dans les propriétés de la méthode. Pour plus d'informations sur ce point, reportez-vous à la section Sécurité des connexions.

Bien qu’une expression puisse contenir directement des appels de fonctions 4D, il est déconseillé d’utiliser ce mode de fonctionnement, pour des raisons de localisation. Par exemple le commentaire , bien que correctement interprété avec un 4D français, ne sera pas traité avec un 4D anglais. Il en va de même pour le traitement des nombres réels (car le séparateur décimal peut varier d’un pays à l’autre). Dans ces deux cas, il est préférable d’affecter une variable par programmation.

En cas d’erreur d’évaluation, le texte inséré sera de la forme “ : ## erreur # code d’erreur”.

Notes :

Vous devez utiliser des variables process.
Il est possible d’afficher le contenu d’un champ image. En revanche, il n’est pas possible d’afficher le contenu d’un élément de tableau image.
Comme le HTML est orienté texte, vous travaillerez généralement avec des variables Texte. Toutefois, vous pouvez également utiliser des variables BLOB. Il vous suffit pour cela de générer des BLOBs en mode Texte sans longueur.

Note de compatibilité : Cette balise plus spécialisée remplace la balise générique 4DVAR à compter de la version 12.2 de 4D. La balise 4DVAR reste prise en charge et fonctionne comme dans les versions précédentes. Il est toutefois conseillé désormais d'utiliser la balise 4DTEXT pour insérer du texte.

Balise 4DHTML

Syntaxe :  ou

Cette balise permet d’évaluer une variable ou une expression 4D et de l’insérer dans une page en tant qu’expression HTML. A la différence de la balise 4DTEXT, cette balise n'échappe pas les caractères HTML spéciaux tels que ">".

Par exemple, voici les résultats de l’insertion de la variable Texte 4D mavar à l’aide des balises 4DTEXT et 4DHTML :

Valeur de mavar	Balises	Insertion dans la page Web
mavar:="<B>"	<!--#4DTEXT mavar-->	<B>
mavar:="<B>"	<!--#4DHTML mavar-->	<B>

En cas d’erreur d’évaluation, le texte inséré sera de la forme “ : ## erreur # code d’erreur”.

Note : L'exécution d'une méthode 4D avec 4DHTML est soumise à la valeur de l’attribut “Disponible via les balises HTML et URLs 4D (4DACTION...)” défini dans les propriétés de la méthode. Pour plus d'informations sur ce point, reportez-vous à la section Sécurité des connexions.

Note de compatibilité : Cette balise remplace la balise 4DHTMLVAR à compter de la version 12.2 de 4D. La balise 4DHTMLVAR reste prise en charge mais pour une meilleure lisibilité du code, il est conseillé désormais d'utiliser la balise 4DHTML pour insérer du code HTML.

Balise 4DSCRIPT/

Syntaxe :

La balise 4DSCRIPT/ vous permet d'exécuter des méthodes 4D au moment de l'envoi de pages HTML statiques. La présence dans une page statique du commentaire HTML  provoque l’exécution de la méthode NomMéthode avec le paramètre Param sous forme de chaîne dans $1. Au chargement de la page, 4D appelle la Méthode base Sur authentification Web (si elle existe). Si elle retourne Vrai, 4D exécute la méthode.
La méthode retourne alors du texte dans $0. Si la chaîne débute par le caractère de code 1, elle est considérée comme du HTML (même principe que pour les variables).

Note : L'exécution d'une méthode avec 4DSCRIPT est soumise à la valeur de l’attribut “Disponible via les balises HTML et URLs 4D (4DACTION...)” défini dans les propriétés de la méthode. Pour plus d'informations sur ce point, reportez-vous à la section Sécurité des connexions.

Par exemple, vous insérez dans une page statique le commentaire “Nous sommes le ”. Au chargement de la page, 4D appelle la Méthode base Sur authentification Web (si elle existe) puis la méthode MAMETH en lui passant comme paramètre (dans $1) la chaîne “/MONPARAM”.
La méthode retourne du texte dans $0 (par exemple “28/10/10”), l’expression “Nous sommes le ” devient alors “Nous sommes le 28/10/10”.

Le code de MAMETH est :

 C_TEXTE($0;$1) `Ces paramètres doivent TOUJOURS être déclarés

 $0:=Chaine(Date du jour)

Note : Une méthode appelée par 4DSCRIPT ne doit pas faire appel à des éléments d’interface (DIALOGUE, ALERTE...)

Comme 4D exécute les méthodes dans leur ordre d’apparition, il est tout à fait possible de faire appel à une méthode qui fixe la valeur de plusieurs variables elles-mêmes référencées plus loin dans le document, quel que soit le mode utilisé.

Note : Vous pouvez insérer autant de commentaires  que vous voulez dans une page statique.

Balise 4DINCLUDE

Syntaxe :

Ce commentaire permet d’inclure, dans une page HTML, une autre page HTML (désignée par le paramètre chemin). Par défaut, seul le corps de la page HTML désignée, c'est-à-dire le contenu compris entre les balises <body> et </body>, est inclus (les balises elles-mêmes ne sont pas incluses). Ce principe permet d'éviter les conflits liés aux meta balises présentes dans les en-têtes. Toutefois, si la page HTML désignée ne contient pas de balises <body></body>, la page entière est incluse. Il vous appartient alors de veiller à la cohérence des meta balises.
Le commentaire  s’avère particulièrement utile en combinaison avec les tests () ou les boucles (). Il est également pratique pour inclure des bannières en fonction d’un critère, ou de manière aléatoire.
Au moment de l’inclusion, quelle que soit l’extension du nom du fichier, 4D analyse la page appelée puis insère son contenu — éventuellement modifié — dans la page d’où provient l’appel 4DINCLUDE.

Le placement dans le cache Web d’une page incluse à l’aide du commentaire  répond aux mêmes règles que celles des pages demandées via un URL ou envoyées par la commande WEB ENVOYER FICHIER.

Passez dans chemin le chemin d’accès au document à inclure. Attention : Dans le cas de la balise 4DINCLUDE, le chemin d’accès doit être défini relativement au document en cours d’analyse, c'est-à-dire au document “parent”, et non à la racine du serveur. Utilisez la barre oblique (/) comme séparateur de dossiers et les deux-points (..) pour remonter d’un niveau hiérarchique (syntaxe HTML).

Notes :

Lorsque vous utilisez la balise 4DINCLUDE avec la commande TRAITER BALISES 4D, le dossier par défaut est le dossier contenant le fichier de structure de la base.
Vous pouvez modifier le dossier par défaut utilisé par la balise 4DINCLUDE dans la page courante, à l'aide de la balise  (cf. ci-dessous).

Le nombre de  au sein d’une page n’est pas limité. Toutefois, les appels à  ne peuvent s’effectuer que sur 1 niveau. Cela signifie que par exemple vous ne pouvez pas insérer le commentaire  dans le corps de la page mondoc2.html, elle-même appelée par  inséré dans mondoc1.html.
En outre, 4D contrôle que les inclusions ne sont pas récursives.

En cas d’erreur, le texte inséré est de la forme " : Le document ne peut pas être ouvert".

Exemples :

<!--#4DINCLUDE souspage.html-->
<!--#4DINCLUDE dossier/souspage.html-->
<!--#4DINCLUDE ../dossier/souspage.html-->

Balise 4DBASE

Syntaxe :

La balise  permet de désigner un répertoire courant qui sera utilisé par la balise .
Lorsqu’elle est appelée dans une page Web, la balise  modifie tous les appels  suivants dans cette page, jusqu’au prochain  éventuel. Si le dossier  est modifié depuis un fichier inclus, il récupère sa valeur d’origine dans le fichier parent.

Le paramètre cheminDossier doit contenir un chemin d’accès relatif à la page courante. Il doit se terminer par une barre oblique (/). Le dossier désigné doit être situé à l’intérieur du dossier Web.
Passez le mot-clé WEBFOLDER pour rétablir le chemin par défaut (relatif à la page).

Ainsi, le code suivant, devant spécifier un chemin relatif à chaque appel :

<!--#4DINCLUDE subpage.html--> 
<!--#4DINCLUDE folder/subpage1.html-->
<!--#4DINCLUDE folder/subpage2.html-->
<!--#4DINCLUDE folder/subpage3.html-->
<!--#4DINCLUDE  ../folder/subpage.html-->

... peut être réécrit à l’aide de la balise  :

<!--#4DINCLUDE subpage.html--> 
<!--#4DBASE folder/-->
<!--#4DINCLUDE subpage1.html-->
<!--#4DINCLUDE subpage2.html-->
<!--#4DINCLUDE subpage3.html-->
<!--#4DBASE ../folder/-->
<!--#4DINCLUDE subpage.html-->
<!--#4DBASE WEBFOLDER-->

Exemple

Définition d’un répertoire pour la page d’accueil à l’aide de la balise  :

/* Index.html */
<!--#4DIF LangFR=True-->
    <!--#4DBASE FR/-->
<!--#4DELSE-->
    <!--#4DBASE US/-->
<!--#4DENDIF-->
<!--#4DINCLUDE head.html-->
<!--#4DINCLUDE body.html-->
<!--#4DINCLUDE footer.html-->

Dans le fichier head.html, le dossier courant est modifié via , sans que cela change sa valeur dans Index.html :

/* Head.htm */
/* ici le répertoire courant est relatif au fichier inclus (FR/ ou US/) */
<!--#4DBASE Styles/-->
<!--#4DINCLUDE main.css-->
<!--#4DINCLUDE product.css-->
<!--#4DBASE Scripts/-->
<!--#4DINCLUDE main.js-->
<!--#4DINCLUDE product.js-->

Balises 4DIF, 4DELSE, 4DELSEIF et 4DENDIF

Syntaxe :  {...} {}

Utilisé en conjonction avec les commentaires  (optionnel),  (optionnel) et , le commentaire  offre la possibilité d’exécuter du code HTML de manière conditionnelle.
Le paramètre expression peut contenir toute expression 4D valide retournant une valeur booléenne. Elle doit figurer entre parenthèses et respecter les règles de syntaxe de 4D.

Les blocs  ...  peuvent être imbriqués sur plusieurs niveaux. Comme dans 4D, chaque  doit avoir un  correspondant.
En cas d’erreur d’évaluation, le texte “ : Une expression booléenne était attendue” est inséré à la place du contenu situé entre  et .
De même, s’il n’y a pas autant de  que de , le texte “ : 4DENDIF attendu” est inséré à la place du contenu situé entre  et .

A l’aide de la balise , vous pouvez tester un nombre illimité de conditions. Seul le code suivant la première condition évaluée à Vrai sera exécuté. Si aucune des conditions n’est vraie, aucune instruction n’est exécutée (s’il n’y a pas de  final).
Vous pouvez utiliser une balise  après le dernier . Si toutes les conditions sont fausses, les instuctions suivant le  seront exécutées.

Les deux codes suivants sont équivalents.

Code utilisant uniquement 4DELSE :

<!--#4DIF Condition1-->
  /* Condition1 est vraie*/
<!--#4DELSE-->
    <!--#4DIF Condition2-->
        /* Condition2 est vraie*/
    <!--#4DELSE-->
        <!--#4DIF Condition3-->
            /* Condition3 est vraie */
        <!--#4DELSE-->
            /*Aucune condition n’est vraie*/
        <!--#4DENDIF-->
    <!--#4DENDIF-->
<!--#4DENDIF-->

Code similaire utilisant la balise 4DELSEIF :

<!--#4DIF Condition1-->
     /* Condition1 est vraie*/
<!--#4DELSEIF Condition2-->
     /* Condition2 est vraie*/
<!--#4DELSEIF Condition3-->
    /* Condition3 est vraie*/
<!--#4DELSE-->
    /* Aucune condition n’est vraie */
<!--#4DENDIF-->

Exemple 1

Cet exemple de code inséré dans une page HTML statique affiche un libellé différent en fonction du résultat de l’expression vnom#"" :

<BODY>
...
<!--#4DIF (vnom#"")-->
Noms commençant par <!--#4DTEXT vnom-->.
<!--#4DELSE-->
Aucun nom n’a été trouvé.
<!--#4DENDIF-->
...
</BODY>

Exemple 2

Cet exemple insère des pages différentes en fonction de l’utilisateur connecté :

<!--#4DIF LoggedIn=False-->
    <!--#4DINCLUDE Login.htm -->
<!--#4DELSEIF User="Admin" -->
    <!--#4DINCLUDE AdminPanel.htm -->
<!--#4DELSEIF User="Manager" -->
    <!--#4DINCLUDE SalesDashboard.htm -->
<!--#4DELSE-->
    <!--#4DINCLUDE ItemList.htm -->
<!--#4DENDIF-->

Balises 4DLOOP et 4ENDLOOP

Syntaxe :

Ce commentaire permet de répéter une portion de code HTML tant que la condition est remplie. La portion est délimitée par  et .
Les blocs  ...  peuvent être imbriqués. Comme dans 4D, chaque  doit avoir un  correspondant.

Il existe trois types de conditions :


Cette syntaxe effectue une boucle pour chaque enregistrement de la sélection courante de table dans le process en cours. La portion de code HTML située entre les deux commentaires est répétée pour chaque enregistrement de la sélection courante.
Note : Lors de l'utilisation de 4DLOOP avec une table, les enregistrements sont chargés en mode Lecture seule.
L’exemple de code HTML suivant :

<!--#4DLOOP [Personnes]-->
<!--#4DTEXT [Personnes]Nom--> <!--#4DTEXT [Personnes]Prenom--><BR>
<!--#4DENDLOOP-->

... pourrait se traduire en langage 4D par :

 DEBUT SELECTION([Personnes])

 Tant que(Non(Fin de selection([Personnes])))

    ...

    ENREGISTREMENT SUIVANT([Personnes])

 Fin tant que


Cette syntaxe effectue une boucle pour chaque élément du tableau. L’indice courant du tableau est incrémenté à chaque répétition de la portion de code HTML.
Il n’est pas possible d’utiliser cette syntaxe avec des tableaux à deux dimensions. Dans ce cas, la solution consiste à combiner une méthode et des boucles imbriquées.

L’exemple de code HTML suivant :

<!--#4DLOOP tab_noms-->
<!--#4DTEXT tab_noms{tab_noms}--><BR>
<!--#4DENDLOOP-->

... pourrait se traduire en langage 4D par :

 Boucle($indice;1;Taille tableau(tab_noms))

    tab_noms:=$indice

    ...

 Fin de boucle


Cette syntaxe effectue une boucle tant que la méthode retourne Vrai. La méthode admet un paramètre de type Entier long. Elle est appelée une première fois avec la valeur 0 pour permettre une éventuelle phase d’initialisation, puis elle est appelée successivement avec les valeurs 1, 2, 3... tant qu’elle renvoie Vrai.
Pour des raisons de sécurité, la Méthode base Sur authentification Web peut être appelée, une seule fois, avant la phase d’initialisation (exécution de la méthode avec 0 comme paramètre). Si l’authentification est confirmée, la phase d’initialisation a lieu.
En vue de la compilation de la base, il est impératif de déclarer C_BOOLEEN($0) et C_ENTIER LONG($1) au sein de la méthode.
L’exemple de code HTML suivant :

<!--#4DLOOP ma_methode-->
<!--#4DTEXT var--> <BR>
<!--#4DENDLOOP-->

... pourrait se traduire en code 4D par :

 Si(AuthentificationWebOK)

    Si(ma_methode(0))

       $compteur:=1

       Tant que(ma_methode($compteur))

          ...

          $compteur:=$compteur+1

       Fin tant que

    Fin de si

 Fin de si

La méthode ma_methode pourrait avoir la forme suivante :

 C_ENTIER LONG($1)

 C_BOOLEEN($0)

 Si($1=0)

  `Initialisation

    $0:=Vrai

 Sinon

    Si($1<50)

       ...

       var:=...

       $0:=Vrai

    Sinon

       $0:=Faux `Arrêt de la boucle

    Fin de si

 Fin de si

En cas d’erreur d’évaluation, le texte “ : descriptif” est inséré à la place du contenu situé entre  et .
Le descriptif de l’erreur peut être l’un des suivants :

Une expression de ce type n’était pas attendue (erreur générique).
Nom de table invalide (erreur sur le nom de la table).
Un tableau était attendu (la variable n’est pas un tableau ou est un tableau à deux dimensions).
La méthode n’existe pas.
Erreur de syntaxe (lors de l’exécution de la méthode).
Erreur de privilège (pas de droits suffisants pour accéder à la table ou à la méthode).
4DENDLOOP attendu (le nombre de  n’est pas égal à celui de ).