Remarque :

la prise en charge de ColdFusion a été supprimée de Dreamweaver CC et des versions ultérieures.

À propos des composants ColdFusion

Les fichiers de composants ColdFusion (CFC) permettent d’encapsuler la logique d’application et d’entreprise au sein d’unités autonomes réutilisables. Ils permettent également de créer rapidement des services Web.

Un composant ColdFusion est une unité logicielle réutilisable écrite en CFML (ColdFusion markup language), qui facilite la réutilisation et la maintenance du code.

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

Remarque :

les CFC ne peuvent être utilisés qu’avec ColdFusion MX ou une version ultérieure. Les CFC ne sont pas pris en charge par la version 5 de ColdFusion.

Les CFC sont conçus pour offrir aux développeurs une méthode d’encapsulage des éléments de leurs sites web, qui soit à la fois simple et puissante. Ces composants s’utilisent généralement pour la logique d’application ou d’entreprise. Utilisez des balises personnalisées pour introduire des éléments de présentation tels que des messages personnalisés ou des menus dynamiques.

L’ajout de parties interchangeables peut rendre les sites dynamiques plus efficaces, comme c’est le cas pour bon nombre d’autres types de structures. Il peut arriver, par exemple, qu’un site dynamique doive exécuter la même requête à maintes reprises ou recalculer le prix total d’un panier d’achats à chaque fois qu’un article est ajouté. Les composants peuvent se charger de ces tâches. Vous pouvez réparer, améliorer, développer, voire remplacer un composant sans que cela ait un grand impact sur le reste de l’application.

Prenons l’exemple d’un magasin en ligne qui calcule les frais de port en fonction du total de la commande passée. Pour les commandes inférieures à 20 €, les frais de port sont de 4 € ; pour les commandes comprises entre 20 € et 40 €, ils sont de 6 €, etc. Vous pourriez insérer la logique de calcul des frais de port sur la page du panier d’achats et sur la page de règlement. Vous seriez alors amené à mélanger du code de présentation HTML et du code de logique CFML. Avec cette méthode, il est cependant souvent difficile de réutiliser et de gérer le code.

Il vaut donc mieux créer un CFC appelé Pricing, incluant entre autres une fonction appelée ShippingCharge. La fonction accepte un argument représentant un prix et renvoie les frais de port. Ainsi, si la valeur de l’argument est de 32,80, la fonction renvoie 6.

Sur les pages du panier d’achats et de règlement, il vous reste à insérer une balise spéciale appelant la fonction ShippingCharge. Lorsque la page est demandée, la fonction est appelée et les frais de port sont renvoyés à la page.

Supposons que le magasin fasse ultérieurement une offre promotionnelle : livraison gratuite pour toute commande d’un montant supérieur à 100 €. Il vous suffit alors de modifier les frais de port à un seul endroit, à savoir la fonction ShippingCharge du composant Pricing, pour que les frais de port soient mis à jour sur toutes les pages utilisant la fonction.

Présentation du panneau Composants (ColdFusion)

Le panneau Composants (Fenêtre > Composants) permet d’afficher et de modifier les composants ColdFusion, ainsi que d’écrire dans la page un code qui appelle la fonction lorsque la page CFM est demandée.

Remarque :

le panneau Composants est uniquement disponible lors de l’affichage d’une page ColdFusion dans le panneau Dreamweaver.

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 automatiquement les balises CFML nécessaires.

Remarque :

selon le composant, il vous faudra peut-être compléter le code manuellement.

  1. Ouvrez une page ColdFusion sous Dreamweaver.

  2. Dans le panneau Composants (Fenêtre > Composants), choisissez Composants CF dans le menu déroulant.

  3. Cliquez sur le bouton Plus (+), complétez la boîte de dialogue Créer un composant, puis cliquez sur OK.

    a. Dans la section Composants, saisissez les détails du composant. Voici une liste partielle :

    Nom  Spécifie le nom de fichier du composant. Ce nom ne peut contenir que des caractères alphanumériques et des caractères de soulignement (_). Il est inutile d’ajouter l’extension de fichier .cfc au nom.

    Répertoire des composants  Spécifie l’emplacement où est enregistré le composant. Sélectionnez le dossier racine de l’application Web (\Inetpub\wwwroot\monapp\, par exemple) ou l’un de ses sous-dossiers.  

    b. Pour définir une ou plusieurs fonctions pour le composant, choisissez Fonctions dans la liste Section, cliquez sur le bouton Plus (+), puis saisissez les détails de la nouvelle fonction.

    Veillez à bien définir le type de valeur renvoyée par la fonction dans l’option Type de renvoi.

    Remarque :

    Si vous choisissez l’option « distant » dans le menu Accès, la fonction peut désormais servir de service Web.

    c. Pour définir un ou plusieurs arguments pour une fonction, choisissez Arguments dans la liste Section, sélectionnez la fonction dans le menu déroulant, cliquez sur le bouton Plus (+), puis saisissez les détails du nouvel argument sur la droite.

  4. Si vous utilisez un serveur de développement distant, téléchargez vers le serveur distant le fichier CFC et tous les fichiers indépendants (tels que ceux utilisés pour mettre en œuvre une fonction ou inclure des fichiers).

    Le téléchargement des fichiers vers le serveur garantit que les fonctionnalités de Dreamweaver, telles que le mode Live et Aperçu dans le navigateur, fonctionnent correctement.

    Dreamweaver écrit un fichier .cfc et l’enregistre dans le dossier spécifié. Le nouveau composant s’affiche également dans le panneau Composants (il vous suffit de cliquer sur Actualiser).

  5. Si vous utilisez un serveur de développement distant, téléchargez vers le serveur distant le fichier CFC et tous les fichiers indépendants (tels que ceux utilisés pour mettre en œuvre une fonction ou inclure des fichiers).

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 qui les concernent dans une arborescence simple à parcourir dans le panneau Composants.

Dreamweaver recherche les composants sur votre serveur d’évaluation (voir Connexion à la base de données sous 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 une 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.

Remarque :

Si vous voulez utiliser Dreamweaver pour inspecter les CFC résidant dans la racine du serveur tout en gérant les fichiers du site dans une racine de site web différente, vous pouvez définir deux sites Dreamweaver. Configurez le premier site de façon à ce qu’il renvoie à la racine du serveur et le second pour qu’il renvoie à la racine du site web. Utilisez le menu Site du panneau Fichiers pour passer rapidement d’un site à l’autre.

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

  1. Ouvrez une page ColdFusion sous Dreamweaver.
  2. Dans le panneau Composants (Fenêtre > Composants), choisissez Composants CF dans le menu déroulant.
  3. Dans le panneau, cliquez sur le bouton Actualiser pour récupérer les composants.

    Les composants sont affichés sur le serveur. Les fichiers CFC des composants s’affichent dans des dossiers.

    Si les composants existants n’apparaissent pas, cliquez sur le bouton Actualiser dans la barre d’outils du panneau.

  4. Pour afficher uniquement les CFC situés dans le dossier de votre site, cliquez sur le bouton Afficher uniquement les fichiers CFC du site actuel, dans la barre d’outils du panneau Composants.

    Remarque :

    cette fonctionnalité n’est disponible que si vous avez défini un ordinateur exécutant ColdFusion MX 6 ou une version ultérieure comme serveur d’évaluation de Dreamweaver.

    Remarque :

    si le site actuel apparaît dans un dossier virtuel sur le serveur distant, le filtrage n’est pas opérationnel.

  5. Cliquez sur le bouton Plus (+) en regard du nom du dossier pour afficher les composants qu’il contient.
    • Pour dresser la liste des fonctions d’un composant, cliquez sur le bouton Plus (+) en regard du nom du composant.

    • Pour connaître les arguments qu’une fonction accepte, ainsi que leur type et leur caractère facultatif ou obligatoire, développez la branche de la fonction dans l’arborescence.

      Aucun bouton Plus (+) ne figure en regard des fonctions sans argument.

    • Pour afficher rapidement les détails d’un argument, d’une fonction ou d’un composant, sélectionnez l’élément dans l’arborescence, puis cliquez sur le bouton Obtenir des détails dans la barre d’outils du panneau.

      Vous pouvez également cliquer sur l’élément avec le bouton droit de la souris (Windows) ou en maintenant la touche Contrôle enfoncée (Macintosh) et choisir Obtenir des détails dans le menu déroulant qui s’affiche.

      Les détails de l’élément sont affichés dans une boîte de message.

Modification de CFC sous Dreamweaver

Dreamweaver permet de modifier de façon rationalisée le code des composants ColdFusion définis dans un site. Vous pouvez, par exemple, ajouter, modifier ou supprimer toute fonction d’un composant sans quitter Dreamweaver.

Pour ce faire, votre environnement de développement doit être configuré comme suit :

  • ColdFusion doit s’exécuter localement.

  • Dans l’onglet Avancé de la boîte de dialogue Définition du site de Dreamweaver, le type d’accès spécifié dans la catégorie du serveur d’évaluation doit être Local/Réseau.

  • Dans l’onglet Avancé de la boîte de dialogue Définition du site, le chemin d’accès à votre dossier racine local doit être identique au chemin d’accès au dossier du serveur d’évaluation (par exemple, c:\Inetpub\wwwroot\cf_projects\myNewApp\). Pour consulter et modifier ces chemins d’accès, choisissez Site > Modifier les sites.

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

Ouvrez une page ColdFusion sous Dreamweaver et affichez les composants dans le panneau Composants. Pour afficher les composants, ouvrez le panneau Composants (Fenêtre > Composants), choisissez Composants CF dans le menu déroulant du panneau, puis cliquez sur le bouton Actualiser dans le panneau.

Comme ColdFusion s’exécute localement, Dreamweaver affiche les composants figurant sur votre disque dur.

Procédez comme suit pour modifier un composant.

  1. Ouvrez une page ColdFusion sous Dreamweaver et affichez les composants dans le panneau Composants (Fenêtre > Composants).
  2. Dans le menu déroulant du panneau, choisissez Composants CF, puis cliquez sur le bouton Actualiser la liste des composants ColdFusion (CFC).

    Comme ColdFusion s’exécute localement, Dreamweaver affiche les composants figurant sur votre disque dur.

    Remarque :

    pour modifier visuellement le jeu d’enregistrements du CFC, double-cliquez sur son nom dans le panneau Liaisons.

  3. Pour modifier un fichier du composant de façon générale, ouvrez le dossier dans lequel il réside et double-cliquez sur le nom du composant dans l’arborescence.

    Le fichier du composant est ouvert en mode Code.

  4. Pour modifier une fonction, un argument ou une propriété spécifique, double-cliquez sur l’élément dans l’arborescence.
  5. Effectuez les modifications manuellement en mode Code.
  6. Enregistrez le fichier (Fichier > Enregistrer).
  7. Pour qu’une nouvelle fonction apparaisse dans le panneau Composants, actualisez la vue en cliquant sur le bouton Actualiser dans la barre d’outils du panneau.

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. Dreamweaver peut vous aider à effectuer cette opération.

Remarque :

pour connaître d’autres modes d’utilisation des composants, consultez la documentation de ColdFusion sous Dreamweaver (Aide > Utilisation de ColdFusion).

  1. Sous Dreamweaver, ouvrez la page ColdFusion qui doit utiliser la fonction de composant.
  2. Basculez en mode Code (Affichage > Code).
  3. Ouvrez le panneau Composants (Fenêtre > Composants), puis choisissez Composants CF dans le menu déroulant.
  4. Recherchez le composant à utiliser et insérez-le à l’aide de l’une des méthodes suivantes :
    • À partir de l’arborescence, faites glisser une fonction sur la page. Du code permettant d’appeler la fonction est inséré dans la page.

    • Sélectionnez la fonction dans le panneau et cliquez sur le bouton Insérer de la barre d’outils du panneau (deuxième bouton à partir de la droite). Dreamweaver insère le code dans la page au niveau du point d’insertion.

  5. Si vous insérez une fonction possédant des arguments, complétez manuellement le code des arguments.

    Pour plus d’informations, consultez la documentation de ColdFusion sous Dreamweaver (Aide > Utilisation de ColdFusion).

  6. Enregistrez la page (Fichier > Enregistrer).

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.

Remarque :

cette fonctionnalité n’est disponible que si vous pouvez accéder à un ordinateur exécutant ColdFusion MX 7 ou une version ultérieure. Pour plus d’informations, voir Activation des améliorations ColdFusion.

 

  1. Créez ou ouvrez un fichier CFC sous Dreamweaver.
  2. Dans le panneau Liaisons (Fenêtre > Liaisons), cliquez sur le bouton Plus (+) et sélectionnez Jeu d’enregistrements (Requête) dans le menu déroulant.

    La boîte de dialogue Jeu d’enregistrements s’affiche. Vous pouvez choisir de travailler dans la boîte de dialogue simple ou avancée.

  3. Pour utiliser une fonction existante du CFC, sélectionnez cette fonction dans la liste déroulante Fonction, puis passez à l’étape 5.

    Le jeu d’enregistrements sera défini dans cette fonction.

  4. Pour définir une nouvelle fonction dans le CFC, cliquez sur le bouton Nouvelle fonction, saisissez le nom de la fonction dans la boîte de dialogue qui apparaît alors, puis cliquez sur OK.

    Ce nom ne peut contenir que des caractères alphanumériques et des caractères de soulignement (_).

  5. Pour définir un jeu d’enregistrements pour la fonction, définissez les options de la boîte de dialogue Jeu d’enregistrements.

    La nouvelle fonction est insérée dans le CFC qui définit le jeu d’enregistrements.

Utilisation d’un jeu d’enregistrements dans un 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.

Remarque :

cette fonctionnalité n’est disponible que si vous pouvez accéder à un ordinateur exécutant ColdFusion MX 7 ou une version ultérieure. Pour plus d’informations, consultez la section Activation des améliorations ColdFusion.

  1. Ouvrez une page ColdFusion sous Dreamweaver.
  2. Dans le panneau Liaisons (Fenêtre > Liaisons), cliquez sur le bouton Plus (+) et sélectionnez Jeu d’enregistrements (Requête) dans le menu déroulant.

    La boîte de dialogue Jeu d’enregistrements s’affiche. Vous pouvez choisir de travailler dans la boîte de dialogue simple ou avancée.

  3. Cliquez sur le bouton Requête CFC.
  4. Remplissez la boîte de dialogue Requête CFC, cliquez sur OK, puis cliquez à nouveau sur OK pour ajouter le jeu d’enregistrements CFC à la liste des sources de contenu disponibles dans le panneau Liaisons.
  5. Utilisez le panneau Liaisons pour lier le jeu d’enregistrements aux divers éléments de la page.

    Pour plus d’informations, voir Ajout de contenu dynamique dans les pages.

Définition de contenu dynamique à l’aide d’un CFC

Vous pouvez définir un jeu d’enregistrements comme source de contenu dynamique sous Dreamweaver en utilisant un CFC qui contient une définition de jeu d’enregistrements.

1. Dans la zone Nom, saisissez le nom du jeu d’enregistrements CFC.

Il est d’usage d’ajouter le préfixe rs aux noms des jeux d’enregistrements, afin de les distinguer des autres noms d’objet 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 dossier parmi ceux qui sont 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 qui sont définis dans le dossier sélectionné.

Si le menu déroulant des composants ne contient aucun composant, ou 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 nouveau 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 des composants, saisissez l’emplacement du CFC, ou recherchez le dossier correspondant.

Remarque :

ce dossier doit être le chemin relatif au dossier racine du site.

5. Dans le menu déroulant Fonction, sélectionnez la fonction contenant 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.

Remarque :

les zones Connexion et SQL sont en lecture seule.

6. Cliquez sur le bouton Modifier pour modifier chaque paramètre (type, valeur, valeur par défaut) qui doit être passé en argument à la fonction.

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 Tester 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 CFC.

8. Cliquez sur OK.

Ce produit est distribué sous licence Creative Commons Attribution - Pas d’utilisation commerciale - Partage à l’identique 3.0 non transposé  Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.

Mentions légales   |   Politique de confidentialité en ligne