Utilisation de composants ColdFusion sous Dreamweaver

À propos des composants ColdFusion

Les fichiers de composant ColdFusion (CFC) vous permettent d'encapsuler la logique métier et d'application dans des unités autonomes et réutilisables. Les CFC offrent également un moyen rapide et facile de créer des services web.

Un CFC est une unité logicielle réutilisable écrite en langage de balisage ColdFusion (CFML), ce qui facilite la réutilisation et la maintenance de votre code.

Vous pouvez utiliser Dreamweaver pour travailler avec des CFC. Pour plus d'informations sur les balises et la syntaxe CFC, consultez la documentation ColdFusion depuis Dreamweaver (Aide > Utilisation de ColdFusion).

Les CFC sont conçus pour offrir aux développeurs un moyen simple mais puissant d'encapsuler les éléments de leurs sites web.En général, vous devriez utiliser les composants pour la logique métier ou d'application. Utilisez les balises personnalisées pour les éléments de présentation tels que les salutations personnalisées, les menus dynamiques, etc.

Comme pour de nombreux autres types de construction, les sites dynamiques peuvent souvent bénéficier de pièces interchangeables. Par exemple, un site dynamique peut exécuter la même requête de façon répétée, ou calculer le prix total des pages de panier et le recalculer chaque fois qu'un article est ajouté. Les composants peuvent se charger de ces tâches. Vous pouvez corriger, améliorer, étendre et même remplacer un composant avec un impact minimal sur le reste de votre application.

Supposons qu'une boutique en ligne calcule les frais d'expédition en fonction du prix des commandes. Pour les commandes de moins de 20 $, les frais d'expédition sont de 4 $ ; pour les commandes entre 20 $ et 40 $, les frais d'expédition sont de 6 $, et ainsi de suite. Vous pourriez insérer la logique de calcul des frais d'expédition dans la page de panier et la page de commande, mais cela mélangerait le code de présentation HTML et le code logique CFML et rendrait généralement le code difficile à maintenir et à réutiliser.

Vous décidez de créer un CFC appelé Pricing qui contient, entre autres, une fonction appelée ShippingCharge.La fonction prend un prix comme argument et renvoie des frais d'expédition. Par exemple, si la valeur de l'argument est 32,80, la fonction renvoie 6.

Dans la page de panier et la page de commande, vous insérez une balise spéciale pour invoquer la fonction ShippingCharge. Lorsque la page est demandée, la fonction est invoquée et des frais d'expédition sont renvoyés à la page.

Plus tard, la boutique annonce une promotion spéciale : expédition gratuite pour toutes les commandes supérieures à 100 $. Vous apportez la modification aux tarifs d'expédition en un seul endroit — la fonction ShippingCharge du composant Pricing — et toutes les pages utilisant la fonction obtiennent automatiquement des frais d'expédition précis.

Présentation du panneau Composants (ColdFusion)

Utilisez le panneau Composants (Fenêtre > Composants) pour afficher et modifier les composants ColdFusion, et ajoutez du code dans la page qui invoque la fonction lorsque la page CFM est demandée.

Création ou suppression d’un CFC sous Dreamweaver

Vous pouvez utiliser Dreamweaver pour définir visuellement un CFC et ses fonctions. Dreamweaver crée un fichier .cfc et insère les balises CFML nécessaires pour vous.

Affichage de CFC sous Dreamweaver

Dreamweaver permet d’examiner visuellement et globalement les composants ColdFusion (CFC) situés dans le dossier de votre site ou sur le serveur. Dreamweaver lit les fichiers CFC et affiche les informations les concernant dans une arborescence facile à parcourir dans le panneau Composants.

Dreamweaver recherche les composants sur votre serveur de test (voir Connexion à la base de données dans Dreamweaver). Si vous créez des CFC ou modifiez des CFC existants, veillez à les transférer sur le serveur d'évaluation afin qu'ils apparaissent dans le panneau Composants.

Pour afficher les composants situés sur un autre serveur, modifiez les paramètres du serveur d'évaluation.

Vous pouvez consulter les informations suivantes relatives aux composants CF :

• dresser la liste de tous les composants ColdFusion définis pour le site ;

• (si vous exécutez ColdFusion MX 7 ou version ultérieure) filtrer la liste pour afficher uniquement les CFC situés dans le dossier de votre site ;

• étudier les fonctions et arguments de chaque composant ;

• examiner les propriétés des fonctions qui servent de services Web.

Pour afficher les CFC dans Dreamweaver, procédez comme suit :

Modification de CFC sous Dreamweaver

Dreamweaver fournit un moyen simplifié de modifier le code des composants ColdFusion définis pour votre emplacement. Par exemple, vous pouvez ajouter, modifier ou supprimer toute fonction de composant sans quitter Dreamweaver.

Pour utiliser cette fonctionnalité, votre environnement de développement doit être configuré comme suit :

• ColdFusion doit s'exécuter localement.

• Dans la boîte de dialogue Définition de site avancée de Dreamweaver, le type d'accès spécifié dans la catégorie Serveur de test doit être Local/Réseau.

• Dans la boîte de dialogue Définition de site avancée, le chemin d'accès de votre dossier racine local doit être identique au chemin d'accès du dossier du serveur de test (par exemple, c:\Inetpub\wwwroot\cf_projects\myNewApp\). Vous pouvez examiner et modifier ces chemins d'accès en sélectionnant Site > Modifier les sites.

• Le composant doit être stocké dans le dossier du site local ou l'un de ses sous-dossiers sur votre disque dur.

Ouvrez n'importe quelle page ColdFusion dans Dreamweaver et affichez les composants dans le panneau Composants. Pour afficher les composants, ouvrez le panneau Composants (Fenêtre > Composants), sélectionnez Composants CF dans le menu contextuel du panneau et cliquez sur le bouton Actualiser sur le panneau.

ColdFusion s'exécutant localement, Dreamweaver affiche les packages de composants sur votre disque dur.

Procédez comme suit pour modifier un composant.

Création de pages web qui emploient des CFC

Pour utiliser la fonction d’un composant dans vos pages web, vous pouvez écrire dans la page un code qui appelle la fonction lorsque la page est demandée. Vous pouvez utiliser Dreamweaver pour vous aider à écrire ce code.

Définition d’un jeu d’enregistrements dans un CFC

Dreamweaver permet de définir un jeu d’enregistrements (requête ColdFusion) dans un composant ColdFusion (CFC). En définissant un jeu d’enregistrements dans un CFC, il n’est plus nécessaire de le définir dans chaque page qui l’utilise. Le jeu d'enregistrements est défini une fois pour toutes dans le CFC, qui est utilisé dans les différentes pages.

Utiliser un jeu d'enregistrements CFC comme source de contenu dynamique

Il est possible d'utiliser un composant ColdFusion (CFC) comme source de contenu dynamique des pages, si ce composant contient une fonction définissant un jeu d'enregistrements.

Définir du contenu dynamique à l'aide d'un CFC

Vous pouvez définir un jeu d'enregistrements comme source de contenu dynamique dans Dreamweaver en utilisant un CFC contenant une définition de jeu d'enregistrements.

1.Dans la zone Nom, saisissez un nom pour le jeu d'enregistrements CFC.

Une pratique courante consiste à ajouter le préfixe rs aux noms de jeux d'enregistrements pour les distinguer des autres noms d'objets dans le code, par exemple : rsPressRelease.

Le nom d’un jeu d’enregistrements ne peut contenir que des caractères alphanumériques et des caractères de soulignement (_). Ils ne doivent pas comporter d’espaces ni de caractères spéciaux.

2. Sélectionnez un package parmi ceux déjà définis sur le serveur.

Si le dossier n'apparaît pas dans le menu déroulant, actualisez la liste en cliquant sur le bouton Actualiser à côté du menu.

Auparavant, vérifiez que vous avez bien transféré vos CFC sur le serveur d'évaluation. Seuls les fichiers CFC sur le serveur d’évaluation sont affichés.

3.Sélectionnez un composant parmi ceux définis dans le package actuellement sélectionné.

Si le menu déroulant des composant ne contient aucun composant, or u si aucun des composants que vous avez créés précédemment n'apparaît, transférez vos fichiers CFC sur le serveur d'évaluation.

4. (Facultatif) Pour créer un composant, cliquez sur le bouton Créer un nouveau composant.

a. Dans la zone Nom, saisissez le nom du nouveau CFC. Ce nom ne peut contenir que des caractères alphanumériques et des caractères de soulignement (_).

b.Dans la zone Répertoire du composant, saisissez l'emplacement de votre CFC ou parcourez pour sélectionner le dossier.

5. Dans le menu contextuel Fonction, sélectionnez la fonction qui contient la définition du jeu d'enregistrements.

Le menu déroulant Fonction ne contient que les fonctions définies dans le composant sélectionné. Si aucune fonction n'apparaît dans le menu déroulant, ou si vos derniers changements n'apparaissent pas dans les fonctions affichées, vérifiez que les derniers changements ont bien été enregistrés et transférés sur le serveur.

6. Modifiez chaque paramètre (type, valeur et valeur par défaut) qui doit être transmis comme argument de fonction en cliquant sur le bouton Modifier.

a. Saisissez une valeur pour le paramètre actuel en sélectionnant le type de valeur dans le menu déroulant Valeur et en saisissant la valeur voulue dans la zone située à sa droite. Le type de valeur peut être un paramètre d'URL, une variable de formulaire, un cookie, une variable de session, une variable d'application ou une valeur fixe que vous saisissez.

b. Dans la zone Valeur par défaut, saisissez la valeur par défaut que vous souhaitez attribuer au paramètre. Si aucune valeur n'est renvoyée à l'exécution, la valeur par défaut est utilisée.

c. Cliquez sur OK. 

Il est impossible de modifier la connexion de base de données et la requête SQL du jeu d’enregistrements. Ces champs sont toujours désactivés, et ces données ne sont affichées ici qu’à titre d’information.

7. Cliquez sur Test pour vous connecter à la base de données et créer une instance du jeu d'enregistrements.

Si l'instruction SQL contient des paramètres de page, vérifiez que la colonne Valeur par défaut de la zone Paramètres contient des valeurs test correctes avant de cliquer sur Tester.

Si la requête a été correctement exécutée, le jeu d'enregistrements est affiché dans un tableau. Chaque ligne contient un enregistrement et chaque colonne un champ de cet enregistrement.

Cliquez sur OK pour effacer la requête.

8. Cliquez sur OK.