Uso de componentes de ColdFusion en Dreamweaver

Última actualización el 25 abr 2024
Nota

La compatibilidad con ColdFusion se elimina en Dreamweaver y versiones posteriores.

Componentes de ColdFusion

Los archivos de componente ColdFusion (CFC) permiten encapsular aplicación y lógica empresarial en unidades autónomas y reutilizables.Los CFC también proporcionan una forma rápida y sencilla de crear servicios web.

Un CFC es una unidad de software reutilizable escrita en lenguaje de marcado ColdFusion (CFML), lo que facilita la reutilización y el mantenimiento del código.

Puede utilizar Dreamweaver para trabajar con archivos CFC. Para obtener información sobre las etiquetas y la sintaxis de CFC, consulte la documentación de ColdFusion desde Dreamweaver (Ayuda > Uso de ColdFusion).

Nota

Sólo es posible utilizar CFC con ColdFusion MX o una versión posterior. Los CFC no son compatibles con ColdFusion 5.

Los CFC están diseñados para proporcionar una forma sencilla pero potente para que los desarrolladores encapsulen elementos de sus sitios web.En general, debes usar componentes para la lógica de la aplicación o empresarial.Utilice etiquetas personalizadas para elementos de presentación como saludos personalizados, menús dinámicos, etc.

Como con muchos otros tipos de construcción, los sitios dinámicos a menudo pueden beneficiarse de piezas intercambiables.Por ejemplo, un sitio dinámico puede ejecutar la misma consulta repetidamente, o calcular el precio total de las páginas del carro de compras y recalcularlo cada vez que se añade un artículo.Los componentes pueden realizar estas tareas. Puedes arreglar, mejorar, extender e incluso reemplazar un componente con un impacto mínimo en el resto de tu aplicación.

Supón que una tienda web calcula los gastos de envío basándose en el precio de los pedidos.Para pedidos de menos de 20 $, el gasto de envío es de 4 $; para pedidos entre 20 $ y 40 $, el gasto de envío es de 6 $, y así sucesivamente.Podrías insertar la lógica para calcular el coste de envío tanto en la página del carro de compras como en la página de cierre de compra, pero eso mezclaría el código de presentación HTML y el código de lógica CFML y, en general, haría el código difícil de mantener y reutilizar.

Decides crear un CFC llamado Pricing que tiene, entre otras cosas, una función llamada ShippingCharge.La función toma un precio como argumento y devuelve un gasto de envío.Por ejemplo, si el valor del argumento es 32,80, la función devuelve 6.

Tanto en la página del carro de compras como en la página de cierre de compra, insertas una etiqueta especial para llamar a la función ShippingCharge.Cuando se solicita la página, se invoca la función y se devuelve un gasto de envío a la página.

Más tarde, la tienda anuncia una promoción especial: envío gratuito para todos los pedidos superiores a 100 $.Realizas el cambio en las tarifas de envío en un solo lugar: la función ShippingCharge del componente Pricing, y todas las páginas que usan la función obtienen automáticamente importes de envío precisos.

Introducción al panel Componentes CF (ColdFusion)

Utiliza el panel Components (Ventana > Components) para ver y editar componentes ColdFusion, y añadir código en la página que invoque la función cuando se solicite la página CFM.

Nota

El panel Components solo está disponible cuando se visualiza una página ColdFusion en Dreamweaver.

Creación o eliminación de un CFC en Dreamweaver

Puede utilizar Dreamweaver para definir visualmente un CFC y sus funciones. Dreamweaver crea un archivo .cfc e inserta las etiquetas CFML necesarias por ti.

Nota

Según el componente es posible que deba completar el código manualmente.

Abrir una página de ColdFusion en Dreamweaver.

En el panel Componentes (Ventana > Componentes), seleccione Componentes CF del menú emergente.

Haga clic en el botón Más (+), complete el cuadro de diálogo Crear componentes y haga clic en Aceptar.

a. En la sección Componentes, introduzca los detalles del componente. A continuación se incluye una lista parcial:

Nombre Especifica el nombre de archivo del componente. El nombre solo debe contener caracteres alfanuméricos y guiones bajos (_). No especifique la extensión .cfc cuando introduzca el nombre.

Directorio componente Especifica dónde se guarda el componente. Seleccione la carpeta raíz de la aplicación Web (como por ejemplo \Inetpub\wwwroot\myapp\) o cualquiera de sus subcarpetas.  

b.Para definir una o más funciones para el componente, seleccione Funciones de la lista Sección, haga clic en el botón Más (+) e introduzca los detalles de la nueva función.

Asegúrese de que especifica el tipo de valor devuelto por la función en la opción Tipo de retorno.

Nota

Si selecciona Remoto en el menú Acceso, la función pasará a estar disponible como servicio Web.

c.Para definir uno o más argumentos para una función, seleccione Argumentos de la lista Sección, seleccione la función del menú emergente, haga clic en el botón Más (+) e introduzca los detalles del nuevo argumento en la derecha.

Si usa un servidor de desarrollo remoto, cargue el archivo CFC y cualquier archivo dependiente (como los que se usan para implementar una función o incluir archivos) al servidor remoto.

Cargar los archivos garantiza que las funciones de Dreamweaver como Vista en directo y Vista previa en explorador funcionen correctamente.

Dreamweaver escribe un archivo CFC y lo guarda en la carpeta que especificaste.El nuevo componente también aparece en el panel Componentes (después de hacer clic en Actualizar).

Si usa un servidor de desarrollo remoto, cargue el archivo CFC y cualquier archivo dependiente (como los que se usan para implementar una función o incluir archivos) al servidor remoto.

Visualización de CFC en Dreamweaver

Dreamweaver permite examinar visualmente los componentes de ColdFusion (CFC) ubicados en la carpeta del sitio o en el todo el servidor. Dreamweaver lee los archivos CFC y muestra información sobre ellos en una vista de árbol fácil de navegar en el panel Componentes.

Dreamweaver busca los componentes en tu servidor de prueba (consulta Conectarse a la base de datos en Dreamweaver).Si crea archivos CFC o realiza modificaciones en los que ya existen, no olvide cargar los archivos CFC en el servidor de prueba para que se reflejen con precisión en el panel Componentes.

Para ver los componentes situados en otro servidor, cambie la configuración del servidor de prueba.

Puede visualizar cualquier información de la siguiente sobre sus componentes de CF:

  • Mostrar todos los componentes de ColdFusion definidos para el servidor.

  • Si ejecuta ColdFusion MX 7 o una versión posterior, filtrar la lista para mostrar solamente los CFC ubicados en la carpeta del sitio.

  • Explorar las funciones y los argumentos de cada componente.

  • Consultar las propiedades de las funciones que actúan como servicios Web.

Nota

Para utilizar Dreamweaver con el fin de inspeccionar los CFC que residen en la raíz del servidor mientras administra también los archivos del sitio en la raíz de un sitio Web diferente, puede definir dos sitios de Dreamweaver. Configure el primer sitio de manera que señale a la raíz del servidor y el segundo, a la raíz del sitio web. Utilice el menú emergente sitio del panel Archivos para alternar rápidamente entre los dos sitios.

Para ver CFC en Dreamweaver, siga estos pasos:

Abra cualquier página de ColdFusion en Dreamweaver.
En el panel Componentes (Ventana > Componentes), seleccione Componentes CF del menú emergente.
Haga clic en el botón Actualizar del panel para recuperar los componentes.

El paquete de componentes aparece en el servidor. Un paquete de componentes es una carpeta que contiene archivos CFC.

Si los paquetes de componentes existentes no aparecen, haga clic en el botón Actualizar de la barra de herramientas del panel.

Para mostrar solo los CFC ubicados en la carpeta del sitio, haga clic en el botón Mostrar solo CFC del sitio actual en la barra de herramientas del panel Componentes.
Nota

Esta función está disponible solo si ha definido un ordenador que ejecute ColdFusion MX 6 o posterior como servidor de prueba para Dreamweaver.

Nota

Si el sitio actual se encuentra en una carpeta virtual del servidor remoto, el filtrado no funciona.

Haga clic en el botón Más (+) junto al nombre del paquete para ver los componentes almacenados en el paquete.
  • Para enumerar las funciones de un componente, haga clic en el botón Más (+) junto al nombre del componente.

  • Para ver los argumentos que toma una función, así como el tipo de los argumentos y si son obligatorios u opcionales, abra la rama de la función en la vista de árbol.

    Las funciones que no toman argumentos no tienen botón Más (+) junto a ellas.

  • Para ver rápidamente los detalles de un argumento, una función, un componente o un paquete, seleccione el elemento en la vista de árbol y haga clic en el botón Obtener detalles en la barra de herramientas del panel.

    También puede hacer clic con el botón derecho (Windows) o Control+clic (Macintosh) en el elemento y seleccionar Obtener detalles del menú emergente.

    Los detalles sobre el elemento se muestran en un cuadro de mensaje.

Edición de CFC en Dreamweaver

Dreamweaver proporciona una manera simplificada de editar el código de los componentes de ColdFusion definidos para tu sitio.Por ejemplo, puedes agregar, cambiar o eliminar cualquier función de componente sin salir de Dreamweaver.

Para usar esta función, tu entorno de desarrollo debe estar configurado de la siguiente manera:

  • ColdFusion debe ejecutarse localmente.

  • En el cuadro de diálogo avanzado de Definición del sitio en Dreamweaver, el tipo de acceso especificado en la categoría Servidor de prueba debe ser Local/Red.

  • En el cuadro de diálogo avanzado de Definición del sitio, la ruta de tu carpeta raíz local debe ser la misma que la ruta de la carpeta del servidor de prueba (por ejemplo, c:\Inetpub\wwwroot\cf_projects\myNewApp\). Puedes examinar y cambiar estas rutas seleccionando Sitio > Editar sitios.

  • El componente debe estar almacenado en la carpeta del sitio local o en cualquiera de sus subcarpetas en tu disco duro.

Abre cualquier página de ColdFusion en Dreamweaver y muestra los componentes en el panel Componentes.Para mostrar los componentes, abre el panel Componentes (Ventana > Componentes), selecciona Componentes CF del menú emergente del panel y haz clic en el botón Actualizar del panel.

Debido a que ColdFusion se ejecuta localmente, Dreamweaver muestra los paquetes de componentes en tu disco duro.

Siga este procedimiento para editar un componente.

Abre cualquier página de ColdFusion en Dreamweaver y muestra los componentes en el panel Componentes (Ventana > Componentes).
Selecciona Componentes CF del menú emergente del panel y haz clic en el botón Actualizar del panel.

Debido a que ColdFusion se ejecuta localmente, Dreamweaver muestra los paquetes de componentes en tu disco duro.

Nota

Para editar el conjunto de registros CFC visualmente, haz doble clic en él en el panel Enlaces.

Para editar un archivo de componente en general, abre el paquete y haz doble clic en el nombre del componente en la vista de árbol.

El archivo del componente se abre en la vista de Código.

Para editar una función, argumento o propiedad específica, haz doble clic en el elemento en la vista de árbol.
Realice los cambios deseados manualmente en la vista de Código.
Guarde el archivo (Archivo > Guardar).
Para ver cualquier función nueva en el panel Componentes, actualice la vista haciendo clic en el botón Actualizar en la barra de herramientas del panel.

Creación de páginas web que utilicen CFC

Una forma de utilizar una función de componente en las páginas web consiste en escribir código en la página que activa la función cuando se solicita la página. Puedes usar Dreamweaver para ayudarte a escribir este código.

Nota

Para otras maneras de utilizar componentes, consulte la documentación de ColdFusion desde Dreamweaver (Ayuda > Uso de ColdFusion).

En Dreamweaver, abre la página de ColdFusion que usará la función del componente.
Cambie a la vista de Código (Ver > Código).
Abrir el panel Componentes (Ventana > Componentes) y seleccionar Componentes CF del menú emergente del panel.
Busca el componente que quieres e insértalo usando una de las siguientes técnicas:
  • Arrastrar una función de la vista de árbol a la página.Se insertará el código en la página para activar la función.

  • Seleccionar la función en el panel y hacer clic en el botón Insertar en la barra de herramientas del panel (el segundo botón de la derecha).Dreamweaver inserta el código en la página en el punto de inserción.

Si insertas una función que tiene argumentos, completa el código del argumento a mano.

Para obtener más información, consulte la documentación de ColdFusion desde Dreamweaver (Ayuda > Uso de ColdFusion).

Guardar la página (Archivo > Guardar).

Definición de un juego de registros en un CFC

Puede utilizar Dreamweaver para definir un juego de registros (también conocido como consulta ColdFusion) en un componente de ColdFusion (CFC). Al definir un juego de registros en un CFC, no es necesario definirlo en cada página que lo utilice. Basta con definir el juego de registros una sola vez en el CFC y utilizarlo en las distintas páginas.

Nota

Esta función sólo está disponible si se accede a un equipo que ejecute ColdFusion MX 7 o una versión posterior. Para más información, consulte Activación de las mejoras de ColdFusion.

 

Cree o abra un archivo CFC existente en Dreamweaver.
En el panel Bindings (Ventana > Bindings), haz clic en el botón Más (+) y selecciona Recordset (Query) del menú emergente.

Aparecerá el cuadro de diálogo Juego de registros. Puedes trabajar tanto en los cuadros de diálogo de Recordset simples como avanzados.

Para usar una función existente en el CFC, seleccionar la función del menú emergente Función y continuar al paso 5.

El juego de registros se definirá en la función.

Para definir una nueva función en el CFC, hacer clic en el botón Nueva función, introducir un nombre para la función en el cuadro de diálogo que aparece y, a continuación, hacer clic en Aceptar.

El nombre debe contener únicamente caracteres alfanuméricos y guiones bajos (_).

Para definir un recordset para la función, complete las opciones del cuadro de diálogo Recordset.

La nueva función se inserta en el CFC que define el recordset.

Usar un recordset de CFC como fuente de contenido dinámico

Puede utilizar un componente de ColdFusion (CFC) como fuente de contenido dinámico para sus páginas si el componente contiene una función que defina el juego de registros.

Nota

Esta función sólo está disponible si se accede a un equipo que ejecute ColdFusion MX 7 o una versión posterior. Para obtener más información, consulte Activación de las mejoras de ColdFusion.

Abra una página de ColdFusion en Dreamweaver.
En el panel Bindings (Ventana > Bindings), haz clic en el botón Más (+) y selecciona Recordset (Query) del menú emergente.

Aparecerá el cuadro de diálogo Juego de registros. Puedes trabajar tanto en el cuadro de diálogo de Recordset simple como en el avanzado.

Haga clic en el botón CFC Query (Consulta CFC).
Completa el cuadro de diálogo de consulta de CFC, haz clic en Aceptar y, a continuación, haz clic en Aceptar de nuevo para agregar el recordset de CFC a la lista de fuentes de contenido disponibles en el panel Bindings.
Usa el panel Bindings para vincular el recordset a varios elementos de página.

Para obtener más información, consulta Adición de contenido dinámico a páginas.

Definir contenido dinámico mediante un CFC

Puedes definir un recordset como fuente de contenido dinámico en Dreamweaver mediante un CFC que contenga una definición de recordset.

1.En el cuadro Nombre, introduce un nombre para el recordset de CFC.

Una práctica habitual es agregar el prefijo rs a los nombres de recordset para distinguirlos de otros nombres de objeto en el código, por ejemplo: rsPressRelease.

Los nombres de juegos de registros solo deben contener caracteres alfanuméricos y guiones bajos (_). No puede incluir caracteres especiales ni espacios.

2. Seleccionar un paquete de los ya definidos en el servidor.

Si el paquete no aparece en el menú emergente, puede actualizar la lista haciendo clic en el botón Actualizar que se encuentra junto al menú emergente.

Asegúrese de que primero ha cargado los CFC en el servidor de prueba. Sólo se muestran los CFC del servidor de prueba.

3. Seleccionar un componente de los definidos en el paquete actualmente seleccionado.

Si el menú emergente del componente no contiene ningún componente, o bien si ninguno de los componentes creados previamente aparece en el menú, deberá cargar los archivos CFC en el servidor de prueba.

4.(Opcional) Para crear un componente, haz clic en el botón Crear nuevo componente.

a. En el cuadro Nombre, introduzca un nombre para el nuevo CFC. El nombre solo debe contener caracteres alfanuméricos y guiones bajos (_).

b.En el cuadro Directorio de componentes, introduce la ubicación de tu CFC o examina para localizar la carpeta.

Nota

La carpeta debe estar en la ruta relativa a la carpeta raíz del sitio.

5.En el menú emergente Función, seleccione la función que contiene la definición del conjunto de registros.

El menú emergente Función contiene solo las funciones definidas en el componente seleccionado actualmente. Si no aparece ninguna función en el menú emergente, o si no se reflejan los últimos cambios realizados en las funciones que aparecen, verifique que estos cambios se guardaron y se cargaron en el servidor.

Nota

Los cuadros Conexión y SQL son de sólo lectura.

6.Edite cada parámetro (tipo, valor y valor predeterminado) que debe pasarse como argumento de función haciendo clic en el botón Editar.

a. Escriba un valor para el parámetro actual. Para ello, seleccione el tipo de valor en el menú emergente Valor y escriba el valor en el cuadro de la derecha. El tipo de valor puede ser un parámetro de URL, una variable de formulario, una cookie, una variable de sesión, una variable de aplicación o un valor introducido.

b. Introduzca un valor predeterminado para el parámetro en el cuadro Valor predeterminado. Si no se devuelve ningún valor de tiempo de ejecución, se utilizará el valor de parámetro predeterminado.

c.Haga clic en Aceptar. 

No es posible modificar la conexión de base de datos y la consulta SQL del juego de registros. Estos campos aparecen siempre desactivados: la conexión y la consulta SQL solo se muestran a título informativo.

7.Haga clic en Prueba para conectarse a la base de datos y crear una instancia del conjunto de registros.

Si la declaración SQL contiene parámetros de página, compruebe que la columna Valor predeterminado del cuadro Parámetros contiene valores de prueba válidos antes de hacer clic en Prueba.

Si la consulta se ha realizado correctamente, el juego de registros se muestra en una tabla. Cada fila contiene un registro y cada columna representa un campo de dicho registro.

Haga clic en Aceptar para vaciar la consulta CFC.

8.Haga clic en Aceptar.