Ajout de comportements de serveur personnalisés sous Dreamweaver

À propos des comportements de serveur personnalisés

Dreamweaver est fourni avec un ensemble de comportements de serveur intégrés qui vous permettent d'ajouter facilement des fonctionnalités dynamiques à un site.Vous pouvez étendre la fonctionnalité de Dreamweaver en créant des comportements de serveur adaptés à vos besoins de développement, ou en obtenant des comportements de serveur depuis le site web Dreamweaver Exchange.

Avant de créer vos propres comportements de serveur, vous devez vérifier le site web Dreamweaver Exchange pour voir si un tiers a déjà créé un comportement de serveur qui fournit la fonctionnalité que vous souhaitez ajouter à votre site web. Souvent, un développeur tiers a créé et testé un comportement de serveur qui répond à vos besoins.

Accès à Dreamweaver Exchange

Installer un comportement de serveur ou une autre extension dans Dreamweaver

Déroulement du travail des comportements de serveur personnalisés

Si vous êtes un développeur web maîtrisant ColdFusion, JavaScript, VBScript ou PHP, vous pouvez écrire vos propres comportements de serveur. Les étapes pour créer un comportement de serveur comprennent les tâches suivantes :

• Écrire un ou plusieurs blocs de code qui effectuent l'action requise.

• Spécifier où le bloc de code doit être inséré dans le code HTML de la page.

• Si le comportement de serveur nécessite qu'une valeur soit spécifiée pour un paramètre, créez une boîte de dialogue qui invite le développeur web appliquant le comportement à fournir une valeur appropriée.

• Tester le comportement de serveur avant de le rendre disponible à d’autres utilisateurs.

Utilisation du Créateur de comportements de serveur

Utilisez le générateur de comportements de serveur pour ajouter le bloc ou les blocs de code que le comportement insère dans une page.

Options avancées

Après avoir spécifié le code source et l'emplacement d'insertion pour chaque bloc de code, le comportement de serveur est complètement défini. Dans la plupart des cas, vous n'avez pas besoin de spécifier d'informations supplémentaires.

Si vous êtes un utilisateur avancé, vous pouvez définir n'importe laquelle des options suivantes :

Spécifie si le bloc de code doit être traité comme un identifiant.

Par défaut, chaque bloc de code constitue un identificateur. Si Dreamweaver trouve un bloc de code identifiant n'importe où dans un document, il répertorie le comportement dans le panneau Comportements de serveur. Utilisez l'option Identifiant pour spécifier si le bloc de code doit être traité comme un identifiant.

Au moins un des blocs de code du comportement de serveur doit être un identifiant. Un bloc de code ne doit pas être un identifiant si l'une des conditions suivantes s'applique : le même bloc de code est utilisé par un autre comportement de serveur ; ou le bloc de code est si simple qu'il pourrait se produire naturellement sur la page.

Indique le titre du comportement dans le panneau Comportements de serveur.

Lorsque le concepteur de page clique sur le bouton Plus (+) du panneau Comportements de serveur, le titre du nouveau comportement de serveur apparaîtra dans le menu déroulant. Lorsqu'un concepteur applique une instance d'un comportement de serveur à un document, le comportement apparaît dans la liste des comportements appliqués dans le panneau Comportements de serveur.Utilisez la zone Titre du comportement de serveur pour spécifier le contenu du menu déroulant Plus (+) et la liste des comportements appliqués.

La valeur initiale dans la zone est le nom que vous avez fourni dans la boîte de dialogue Nouveau comportement de serveur.Lorsque les paramètres sont définis, le nom est automatiquement mis à jour afin que les paramètres apparaissent entre parenthèses après le nom du comportement de serveur.

Définir la variable de session (@@Name@@, @@Value@@)

Si l'Utilisateur accepte la Valeur par défaut, tout ce qui précède les parenthèses apparaît dans le menu déroulant Plus (+) (par exemple, Définir la Variable de session). Le nom plus les paramètres apparaîtront dans la liste des comportements appliqués — par exemple, Définir la Variable de session ("abcd", "5").

Spécifie le bloc de code sélectionné lorsque l'utilisateur sélectionne le comportement dans le panneau Comportements du serveur.

Lorsque vous appliquez un comportement de serveur, l'un des blocs de code du comportement est désigné comme « bloc de code à sélectionner ». Si vous appliquez le comportement de serveur puis sélectionnez le comportement dans le panneau Comportements de serveur, le bloc désigné est sélectionné dans la fenêtre du document.Par défaut, Dreamweaver sélectionne le premier bloc de code qui ne se trouve pas au-dessus de la balise html.Si tous les blocs de code se trouvent au-dessus de la balise html, alors le premier est sélectionné.Les utilisateurs avancés peuvent spécifier quel bloc de code constitue le bloc sélectionné.

Création de blocs de code

Les blocs de code que vous créez dans le Générateur de comportements de serveur sont encapsulés dans un comportement de serveur qui s'affiche dans le panneau Comportements de serveur.Le code peut être tout code d'exécution valide pour le modèle de serveur spécifié.Par exemple, si vous choisissez ColdFusion comme type de document pour votre comportement de serveur personnalisé, le code que vous écrivez doit être du code ColdFusion valide qui s'exécute sur un serveur d'applications ColdFusion.

Vous pouvez créer les blocs de code directement dans le Générateur de comportement de serveur, ou vous pouvez copier et coller le code depuis d'autres sources.Chaque bloc de code que vous créez dans le Générateur de comportement de serveur doit être une seule balise ou un seul bloc de script.Si vous devez insérer plusieurs blocs de balises, divisez-les en blocs de code séparés.

Conditions dans les blocs de code

Dreamweaver vous permet de développer des blocs de code qui intègrent des instructions de contrôle qui s'exécutent conditionnellement. Le Générateur de comportement de serveur utilise les instructions if, elseif et else, et peut également contenir des paramètres de comportement de serveur.Cela vous permet d'insérer des blocs de texte alternatifs basés sur les valeurs des relations OU entre les paramètres de comportement de serveur.

L'exemple suivant montre les instructions if, elseif et else. Les crochets ([ ]) indiquent du code optionnel et l'astérisque (*) indique zéro ou plusieurs instances.Pour exécuter une partie d'un bloc de code ou l'intégralité du bloc de code uniquement si certaines conditions s'appliquent, utilisez la syntaxe suivante :

<@ if (expression1) @> conditional

text1[<@ elseif (expression2) @> conditional text2]*[<@ else @>

conditional text3]<@ endif @>

Les expressions de condition peuvent être toute expression JavaScript qui peut être évaluée à l'aide de la fonction JavaScript eval(), et peuvent inclure un paramètre de comportement de serveur marqué par des @@.(Les @@ permettent de distinguer le paramètre des variables et mots-clés JavaScript.)

Utilisation efficace des expressions conditionnelles

Lors de l'utilisation des directives if, else et elseif dans la balise XML insertText, le texte participant est prétraité pour résoudre les directives if et déterminer quel texte inclure dans le résultat.Les directives if et elseif prennent l'expression comme argument.L'expression de condition est la même que pour les expressions de condition JavaScript, et peut également contenir des paramètres de comportement de serveur.Des directives comme celle-ci vous permettent de choisir entre différents blocs de code en fonction des valeurs des paramètres de comportement du serveur ou des relations entre eux.

Par exemple, le code JSP suivant provient d'un comportement serveur Dreamweaver qui utilise un bloc de code conditionnel :

@@rsName@@.close();

<@ if (@@callableName@@ != '') @>

@@callableName@@.execute();

@@rsName@@ = @@callableName@@.getResultSet();<@ else @>

@@rsName@@ = Statement@@rsName@@.executeQuery();

<@ endif @>

@@rsName@@_hasData = @@rsName@@.next();

Le bloc de code conditionnel commence par <@ if (@@callableName@@ != '') @> et se termine par <@ endif @>. Selon le code, si l'utilisateur saisit une Value pour le paramètre @@callableName@@ dans la boîte de dialogue Paramètre du comportement serveur — en d'autres termes, si la Value du paramètre @@callableName@@ n'est pas nulle, ou (@@callableName@@ != '') — alors le bloc de code conditionnel est remplacé par les instructions suivantes :

@@callableName@@.execute();

@@rsName@@ = @@callableName@@.getResultSet();

Sinon, le bloc de code est remplacé par l'instruction suivante :

@@rsName@@ = Statement@@rsName@@.executeQuery();

Positionnement d’un bloc de code

Lorsque vous créez des blocs de code à l'aide du Générateur de comportements serveur, vous devez spécifier où les insérer dans le code HTML de la page.

Par exemple, si vous insérez un bloc de code au-dessus de la balise d'ouverture <html>, vous devez ensuite spécifier la position du bloc de code par rapport aux autres balises, scripts et comportements serveur dans cette section du code HTML de la page. Les exemples typiques incluent le positionnement d'un comportement soit avant soit après toute requête de jeu d'enregistrements qui pourrait également exister dans le code de page au-dessus de la balise d'ouverture <html>.

Lorsque vous sélectionnez une option de positionnement dans le menu contextuel Insérer le code, les options disponibles dans le menu contextuel Position relative changent pour fournir des options pertinentes pour cette partie de la page. Par exemple, si vous sélectionnez Au-dessus de la balise <html> dans le menu contextuel Insérer le code, les options de positionnement disponibles dans le menu contextuel Position relative reflètent les choix pertinents pour cette partie de la page.

Le tableau suivant afficher les options d'insertion de bloc de code et les options de positionnement relatif disponibles pour chacune :

Pour spécifier une position personnalisée, vous devez attribuer un poids au bloc de code.Utilisez l'option Position personnalisée lorsque vous devez insérer plusieurs blocs de code dans un ordre particulier. Par exemple, pour insérer une série ordonnée de trois blocs de code après les blocs de code qui ouvrent les jeux d'enregistrement, vous devez saisir un poids de 60 pour le premier bloc, 65 pour le second et 70 pour le troisième.

Par défaut, Dreamweaver attribue un poids de 50 à tous les blocs de code d'ouverture de recordset insérés au-dessus de la balise <html>.Si le poids de deux blocs ou plus correspond, Dreamweaver définit l'ordre de façon aléatoire parmi les blocs.

Positionner un bloc de code (instructions générales)

Positionner un bloc de code par rapport à une autre balise sur la page

Positionner un bloc de code par rapport à une balise sélectionnée par le concepteur de la page

Répétitions des blocs de code à l’aide de la directive de boucle

Pour répéter une portion d'un bloc de code ou le bloc de code entier un certain nombre de fois, utilisez la syntaxe suivante :

<@ loop (@@param1@@,@@param2@@) @> code

block<@ endloop @>

Lorsque vous créez des comportements de serveur, vous pouvez utiliser des structures de boucle pour répéter un bloc de code un nombre spécifié de fois.<@ loop (@@param1@@,@@param2@@,@@param3@@,@@param_n@@) @> bloc de code <@ endloop @>La directive de boucle accepte une liste séparée par des virgules d'tableaux de paramètres comme arguments. Dans ce cas, les arguments de tableau de paramètres permettent à un utilisateur de fournir plusieurs valeurs pour un seul paramètre. Le texte répétitif est dupliqué n fois, où n est la longueur des arguments de tableau de paramètres. Si plus d'un argument de tableau de paramètres est spécifié, tous les tableaux doivent avoir la même longueur. Lors de la ie évaluation de la boucle, les ies éléments des tableaux de paramètres remplacent les instances de paramètres associées dans le bloc de code.

Lorsque vous créez une boîte de dialogue pour le comportement serveur, vous pouvez ajouter un contrôle à la boîte de dialogue qui permet au concepteur de page de créer des tableaux de paramètres. Dreamweaver inclut un contrôle de tableau simple que vous pouvez utiliser pour créer des boîtes de dialogue. Ce contrôle, appelé Liste séparée par des virgules de champ de texte, est disponible via le Générateur de comportement serveur. Pour créer des éléments d'interface utilisateur de plus grande complexité, consultez la documentation API pour créer une boîte de dialogue avec un contrôle pour créer des tableaux (un contrôle de grille, par exemple).

Vous pouvez imbriquer n'importe quel nombre de conditions ou une directive de boucle dans une directive conditionnelle. Par exemple, vous pouvez spécifier que si une expression est vraie d'exécuter une boucle.

L'exemple suivant montre comment de tels blocs de code répétitifs peuvent être utilisés pour créer des comportements serveur (l'exemple est un comportement ColdFusion utilisé pour accéder à une procédure stockée) :

<@ loop (@@param1@@,@@param2@@,@@param3@@,@@param_n@@) @> bloc de code

<@ endloop @>

<CFSTOREDPROC procedure="AddNewBook"

datasource=#MM_connection_DSN#

username=#MM_connection_USERNAME#

password=#MM_connection_PASSWORD#>

<CFPROCPARAM type="IN" dbvarname="@CategoryId" value="#Form.CategoryID#"

cfsqltype="CF_SQL_INTEGER">

<CFPROCPARAM type="IN" dbvarname="@ISBN" value="#Form.ISBN#"

cfsqltype="CF_SQL_VARCHAR">

</CFSTOREDPROC>

Dans cet exemple, la balise CFSTOREDPROC peut inclure zéro ou plusieurs balises CFPROCPARAM. Cependant, sans le support de la directive de boucle, il n'y a aucun moyen d'inclure les balises CFPROCPARAM dans la balise CFSTOREDPROC insérée. Si cela devait être créé comme un comportement serveur sans utiliser la directive de boucle, vous devriez diviser cet exemple en deux participants : une balise CFSTOREDPROC principale, et une balise CFPROCPARAM dont le type de participant est multiple.

En utilisant la directive de boucle, vous pouvez écrire la même procédure comme suit :

<CFSTOREDPROC procedure="@@procedure@@"

datasource=#MM_@@conn@@_DSN#

username=#MM_@@conn@@_USERNAME#

password=#MM_@@conn@@_PASSWORD#>

<@ loop (@@paramName@@,@@value@@,@@type@@) @>

<CFPROCPARAM type="IN"

dbvarname="@@paramName@@"

value="@@value@@"

cfsqltype="@@type@@">

<@ endloop @>

</CFSTOREDPROC>

Si l'utilisateur saisissait les valeurs de paramètre suivantes dans la boîte de dialogue Server Behavior Builder :

procedure = "proc1"

conn = "connection1"

paramName = ["@CategoryId", "@Year", "@ISBN"]

value = ["#Form.CategoryId#", "#Form.Year#", "#Form.ISBN#"]

type = ["CF_SQL_INTEGER", "CF_SQL_INTEGER", "CF_SQL_VARCHAR"]

Le comportement serveur insérerait le code d'exécution suivant dans la page :

<CFSTOREDPROC procedure="proc1"

datasource=#MM_connection1_DSN#

username=#MM_connection1_USERNAME#

password=#MM_connection1_PASSWORD#>

<CFPROCPARAM type="IN" dbvarname="@CategoryId" value="#Form.CategoryId#"

cfsqltype="CF_SQL_INTEGER">

<CFPROCPARAM type="IN" dbvarname="@Year" value="#Form.Year#"

cfsqltype="CF_SQL_INTEGER">

<CFPROCPARAM type="IN" dbvarname="@ISBN" value="#Form.ISBN#"

cfsqltype="CF_SQL_VARCHAR">

</CFSTOREDPROC>

Utilisation des variables _length et _index de la directive de boucle

La directive de boucle comprend deux variables intégrées que vous pouvez utiliser pour les conditions if incorporées. Ces variables sont les suivantes : _length et _index. La variable _length correspond à la longueur des tableaux traités par la directive de boucle, tandis que la variable _index correspond à l'index actuel de la directive de boucle.Pour vous assurer que les variables ne sont reconnues que comme directives et non comme paramètres réels à transmettre dans la boucle, n'entourez aucune des deux variables de @@.

Un exemple d'utilisation des variables intégrées consiste à les appliquer à l'attribut import de la directive de page. L'attribut import nécessite une séparation par des virgules des packages. Si la directive loop s'étend autour de l'intégralité de l'attribut import, vous ne généreriez le nom de l'attribut import= qu'à la première itération de la boucle (y compris les guillemets fermants (&quot;)) et n'afficheriez pas de virgule à la dernière itération de la boucle.En utilisant la variable intégrée, vous pouvez l'exprimer comme suit :

<@loop (@@Import@@)@>

<@ if(_index == 0)@>import="

<@endif@>@@Import@@<@if (_index == _length-1)@>"<@else@>,

<@ endif @>

<@endloop@>

Demander un paramètre pour le comportement de serveur

Les comportements de serveur nécessitent souvent que le concepteur de page fournisse une valeur de paramètre. Cette valeur doit être insérée avant que le code du comportement de serveur ne soit inséré dans la page.

Vous créez la boîte de dialogue en définissant les paramètres fournis par le concepteur dans le code. Vous générez ensuite une boîte de dialogue pour le comportement de serveur, qui demande au concepteur de page une valeur de paramètre.

Définissez le paramètre dans le code du comportement de serveur

Vous pouvez également mettre la chaîne en surbrillance, puis cliquer sur le bouton Insérer le paramètre dans le bloc de code. Entrez un nom de paramètre, puis cliquez sur OK. Dreamweaver remplace toutes les occurrences de la chaîne mise en surbrillance par le nom du paramètre entouré de marqueurs.

Dreamweaver utilise les chaînes placées entre les marqueurs de paramètre pour marquer des commandes de la boîte de dialogue qu’il génère (voir la procédure ci-dessous). Dans l’exemple ci-dessus, Dreamweaver crée une boîte de dialogue avec le libellé suivant :

Créez une boîte de dialogue pour votre comportement de serveur afin de demander la valeur du paramètre

Affichage de la boîte de dialogue

Modifiez la boîte de dialogue que vous avez créée pour le comportement de serveur

Modification d’un comportement de serveur

Vous pouvez modifier tout comportement de serveur créé avec le générateur de comportements de serveur, y compris les comportements de serveur que vous téléchargez depuis le site web Dreamweaver Exchange et ceux créés par d'autres développeurs tiers.

Si vous appliquez un comportement de serveur à une page, puis modifiez le comportement dans Dreamweaver, les instances de l'ancien comportement n'apparaissent plus dans le panneau Comportements de serveur. Le panneau Comportements de serveur recherche dans la page le code qui correspond au code des comportements de serveur connus. Si le code d'un comportement de serveur change, le panneau ne reconnaît pas les versions antérieures du comportement sur cette page.

Conservez les anciennes et nouvelles versions du comportement dans le panneau

Modifier le code d'un comportement de serveur créé avec le générateur de comportements de serveur

Instructions pour le codage

En général, le code de votre comportement de serveur doit être compact et robuste. Les développeurs d'applications web sont très sensibles au code ajouté à leurs pages.Suivez les pratiques de codage généralement acceptées pour le langage du type de document (ColdFusion, JavaScript, VBScript ou PHP). Lors de la rédaction de commentaires, tenez compte des différents publics techniques qui pourraient avoir besoin de comprendre le code, tels que les concepteurs web et d'interaction, ou d'autres développeurs d'appli web. Incluez des commentaires qui décrivent avec précision l'objectif du code et toutes les instructions spéciales pour l'inclure dans une page.

Gardez à l'esprit les directives de codage suivantes lorsque vous créez des comportements de serveur :

L’un des éléments indispensables. Le code du comportement de serveur doit gérer les cas d'erreur avec élégance. Essayez de prévoir toutes les éventualités. Par exemple, que se passe-t-il si une demande de paramètre échoue ?Que se passe-t-il si aucun enregistrement n'est renvoyé par une requête ?

Permet de vous assurer que votre code est clairement identifiable et évite les collisions de noms avec le code existant. Par exemple, si la page contient une fonction appelée hideLayer() et une Variable globale appelée ERROR_STRING, et que votre comportement de serveur insère du code qui utilise également ces noms, le comportement de serveur peut entrer en conflit avec le code existant.

Vous permet d'identifier vos propres fonctions d'exécution et Variables globales dans une page. Une convention consiste à employer vos propres initiales. N'utilisez jamais le préfixe MM_, car il est réservé exclusivement à l'utilisation de Dreamweaver. Dreamweaver précède toutes les fonctions et Variables globales avec le préfixe MM_ pour les empêcher d'entrer en conflit avec tout code que vous écrivez.

var MM_ERROR_STRING = "…";

function MM_hideLayer() {

afin que le code que vous écrivez ne ressemble pas trop étroitement au code dans d'autres blocs. Si un bloc de code ressemble trop à un autre bloc de code sur la page, le panneau Comportements de serveur pourrait identifier par erreur le premier bloc de code comme une instance du second bloc de code (ou inversement).Une solution simple consiste à ajouter un commentaire à un bloc de code pour le rendre plus unique.

Test des comportements de serveur

Le Dreamweaver Exchange recommande d'effectuer les test suivants sur chaque comportement de serveur que vous créez :

• Appliquez le comportement à partir du panneau Comportements de serveur. Si il possède une boîte de dialogue, entrez des données valides dans chaque champ et cliquez sur OK. Vérifiez qu’aucune erreur ne se produit lorsque le comportement est appliqué. Vérifiez que le code d'exécution pour le comportement de serveur apparaît dans l'inspecteur de code.

• Appliquez à nouveau le comportement de serveur et entrez des données non valide dans chaque champ de la boîte de dialogue. Essayez de laisser le champ vide, d'utiliser des nombres importants ou négatifs, d'utiliser des caractères non valide (tels que /, ?, :, *, et ainsi de suite), et d'utiliser des lettres dans les champs numériques. Vous pouvez écrire des routines de validation de formulaire pour gérer les données non valides (les routines de validation nécessitent un codage manuel, ce qui dépasse la portée de ce livre).

  Après avoir appliqué avec succès le comportement de serveur à la page, vérifiez les éléments suivants :

• Vérifiez le panneau Comportements de serveur pour vous assurer que le nom du comportement de serveur apparaît dans la liste des comportements ajoutés à la page.

• Le cas échéant, vérifiez que les icônes de Script côté serveur s'affichent sur la page. Les icônes de script côté serveur génériques se présentent sous la forme de blasons dorés. Pour voir les icônes, activez les Éléments invisibles (Affichage > Aides visuelles > Éléments invisibles).

• En mode Code (Affichage > Code), vérifiez qu'aucun code non valide n'est généré.

  De plus, si votre comportement de serveur insère du code dans le document établissant une connexion à une base de données, créez une base de données de test pour tester le code inséré dans le document. Vérifiez la connexion en définissant des requêtes qui produisent différents ensembles de données, et différentes tailles d'ensembles de données.

  Enfin, chargez la page sur le serveur et ouvrez-la dans un navigateur. Affichez le code HTML source de la page et vérifiez qu'aucun HTML non valide n'a été généré par les Script côté serveur.