Usar componentes do ColdFusion no Dreamweaver

Última atualização em 25/04/2024
Nota

O suporte ao ColdFusion foi removido no Dreamweaver e versões posteriores.

Sobre os componentes do ColdFusion

Os arquivos de componente do ColdFusion (CFC) permitem encapsular lógica de aplicativo e de negócios em unidades independentes e reutilizáveis.Os CFCs também oferecem uma maneira rápida e fácil de criar serviços web.

Um CFC é uma unidade de software reutilizável escrita em linguagem de marcação ColdFusion (CFML), que facilita a reutilização e manutenção do código.

Você pode usar o Dreamweaver para trabalhar com CFCs. Para obter informações sobre tags e sintaxe de CFC, consulte a documentação do ColdFusion no Dreamweaver (Ajuda > Usando ColdFusion).

Nota

você só pode usar CFCs com o ColdFusion MX ou posterior. CFCs não são compatíveis com ColdFusion 5.

Os CFCs foram criados para oferecer uma maneira simples, mas poderosa, para desenvolvedores encapsularem elementos de seus sites.Geralmente, você deve usar componentes para aplicativo ou lógica de negócios.Use tags personalizadas para elementos de apresentação, como saudações personalizadas, menus dinâmicos e assim por diante.

Como em muitos outros tipos de construção, sites dinâmicos podem frequentemente se beneficiar de partes intercambiáveis.Por exemplo, um site dinâmico pode executar a mesma consulta repetidamente ou calcular o preço total de páginas do carrinho de compras e recalculá-lo sempre que um item for adicionado.Essas tarefas podem ser tratadas por componentes. Você pode corrigir, melhorar, estender e até mesmo substituir um componente com impacto mínimo no restante do aplicativo.

Suponha que uma loja na web calcule taxas de envio com base no preço dos pedidos.Para pedidos abaixo de US$ 20, a taxa de envio é US$ 4; para pedidos entre US$ 20 e US$ 40, a taxa de envio é US$ 6, e assim por diante.Você poderia inserir a lógica para calcular a taxa de envio tanto na página do carrinho de compras quanto na página de checkout, mas isso misturaria código de apresentação HTML e código lógico CFML, tornando geralmente o código difícil de manter e reutilizar.

Você decide criar um CFC chamado Pricing que tem, entre outras coisas, uma função chamada ShippingCharge.A função recebe um preço como argumento e retorna uma taxa de envio.Por exemplo, se o valor do argumento for 32,80, a função retorna 6.

Tanto na página do carrinho de compras quanto na página de checkout, você insere uma tag especial para invocar a função ShippingCharge.Quando a página é solicitada, a função é invocada e uma taxa de envio é retornada à página.

Mais tarde, a loja anuncia uma promoção especial: envio grátis para todos os pedidos acima de US$ 100.Você faz a alteração nas taxas de envio em um local—a função ShippingCharge do componente Pricing—e todas as páginas que usam a função automaticamente recebem taxas de envio precisas.

Visão geral do painel Componentes (ColdFusion)

Use o painel Componentes (Janela > Componentes) para visualizar e editar componentes ColdFusion e adicionar código na página que invoca a função quando a página CFM é solicitada.

Nota

O painel Componentes está disponível apenas ao visualizar uma página ColdFusion no Dreamweaver.

Criar ou excluir um CFC no Dreamweaver

Você pode usar o Dreamweaver para definir visualmente um CFC e suas funções. Dreamweaver cria um arquivo .cfc e insere as tags CFML necessárias para você.

Nota

Dependendo do componente, você talvez tenha que completar alguns códigos manualmente.

Abra uma página ColdFusion no Dreamweaver.

No painel Componentes (Janela > Componentes), selecione Componentes CF no menu pop-up.

Clique no botão Mais (+) e preencha a caixa de diálogo Criar componentes e clique em OK.

a. Na seção Componentes, informe os detalhes do componente. Aqui está uma lista parcial:

Nome  Especifica o nome de arquivo do componente. O nome deve conter apenas caracteres alfanuméricos e sublinhados (_). Não especifique a extensão de arquivo .cfc ao digitar o nome.

Diretório do componente  Especifica onde o componente é salvo. Selecione a pasta raiz do aplicativo da Web (como, por exemplo, \Inetpub\wwwroot\myapp\) ou qualquer uma das subpastas.  

b.Para definir uma ou mais funções para o componente, selecione Funções na lista Seção, clique no botão Mais (+) e insira os detalhes da nova função.

Verifique se você especificou o tipo do valor retornado pela função na opção Tipo de retorno.

Nota

Caso você selecione remoto no menu Acesso, a função é disponibilizada como um serviço da Web.

c.Para definir um ou mais argumentos para uma função, selecione Argumentos na lista Seção, selecione a função no menu pop-up, clique no botão Mais (+) e insira os detalhes do novo argumento à direita.

Se você usa um servidor de desenvolvimento remoto, faça upload do arquivo CFC e de quaisquer arquivos dependentes (como aqueles usados para implementar uma função ou incluir arquivos) para o servidor remoto.

Fazer upload dos arquivos garante que os recursos do Dreamweaver como Visualização ao vivo e Visualização no navegador funcionem adequadamente.

Dreamweaver escreve um arquivo CFC e o salva na pasta que você especificou.O novo componente também aparece no painel Componentes (após clicar em Atualizar).

Se você usar um servidor de desenvolvimento remoto, faça upload do arquivo CFC e de quaisquer arquivos dependentes (como aqueles usados para implementar uma função ou incluir arquivos) para o servidor remoto.

Exibir CFCs no Dreamweaver

O Dreamweaver fornece uma forma de examinar visualmente os componentes de ColdFusion (CFCs) localizados na pasta do site ou em todo o servidor. Dreamweaver lê os arquivos CFC e exibe informações sobre eles em uma visualização em árvore fácil de navegar no painel Componentes.

Dreamweaver procura pelos componentes no seu servidor de teste (veja Conectando ao banco de dados no Dreamweaver).Caso você crie CFCs ou faça alterações nos CFCs existentes, não se esqueça de carregar os arquivos CFC no servidor de teste para que eles sejam refletidos com precisão no painel Componentes.

Para exibir os componentes localizados em outro servidor, altere as configurações do servidor de teste.

Você pode exibir qualquer uma das seguintes informações sobre os componentes do CF:

  • Listar todos os componentes do ColdFusion definidos no servidor.

  • Caso você esteja executando o ColdFusion MX 7 ou posterior, filtre a lista para mostrar apenas os CFCs localizados na pasta do site.

  • Explorar as funções e os argumentos de cada componente.

  • Inspecionar as propriedades das funções que funcionam como serviços da Web.

Nota

Para usar o Dreamweaver a fim de inspecionar os CFCs que residem na raiz do servidor enquanto também gerencia os arquivos do site em uma raiz diferente, você pode definir dois sites do Dreamweaver. Defina o primeiro site de forma a apontar para a raiz do servidor e o segundo, para a raiz do site. Use o menu pop-up do site no painel Arquivos para alternar rapidamente entre os dois sites.

Para exibir os CFCs no Dreamweaver, siga estas etapas:

Abra qualquer página do ColdFusion no Dreamweaver.
No painel Componentes (Janela > Componentes), selecione Componentes CF no menu pop-up.
Clique no botão Atualizar no painel para recuperar os componentes.

O pacote de componentes é exibido no servidor. Um pacote de componentes é uma pasta que contém arquivos CFC.

Se os pacotes de componente existentes não aparecerem, clique no botão Atualizar na barra de ferramentas do painel.

Para exibir apenas os CFCs localizados na pasta do site, clique no botão Mostrar apenas CFCs do site atual na barra de ferramentas do painel Componentes.
Nota

Este recurso está disponível apenas se você definiu um computador executando ColdFusion MX 6 ou posterior como servidor de teste para o Dreamweaver.

Nota

Se o local atual estiver listado em uma pasta virtual no servidor remoto, a filtragem não funciona.

Clique no botão Mais (+) ao lado do nome do pacote para visualizar os componentes armazenados no pacote.
  • Para listar as funções de um componente, clique no botão Mais (+) ao lado do nome do componente.

  • Para ver os argumentos que uma função aceita, bem como os tipos dos argumentos e se são obrigatórios ou opcionais, abra a ramificação da função na visualização em árvore.

    Funções que não aceitam argumentos não têm botão Mais (+) ao lado delas.

  • Para visualizar rapidamente os detalhes de um argumento, uma função, um componente ou um pacote, selecione o item na exibição em árvore e clique no botão Obter detalhes na barra de ferramentas do painel.

    Você também pode clicar com o botão direito (Windows) ou clicar com Control (Macintosh) no item e selecionar Obter detalhes no menu pop-up.

    Os detalhes sobre o item são exibidos em uma caixa de mensagem.

Editar CFCs no Dreamweaver

O Dreamweaver oferece uma forma simplificada de editar o código dos componentes ColdFusion definidos para seu site.Por exemplo, você pode adicionar, alterar ou excluir qualquer função de componente sem sair do Dreamweaver.

Para usar este recurso, seu ambiente de desenvolvimento deve ser configurado da seguinte forma:

  • O ColdFusion deve estar em execução localmente.

  • Na caixa de diálogo Definição de local avançada no Dreamweaver, o tipo de acesso especificado na categoria Servidor de teste deve ser Local/Rede.

  • Na caixa de diálogo Definição de local avançada, o caminho da sua pasta raiz local deve ser o mesmo que o caminho da pasta do servidor de teste (por exemplo, c:\Inetpub\wwwroot\cf_projects\myNewApp\). Você pode examinar e alterar esses caminhos selecionando Local > Editar locais.

  • O componente deve ser armazenado na pasta do site local ou em qualquer uma de suas subpastas no disco rígido.

Abra qualquer página ColdFusion no Dreamweaver e exiba os componentes no painel Componentes.Para exibir os componentes, abra o painel Componentes (Janela > Componentes), selecione CF Components no menu pop-up do painel e clique no botão Atualizar no painel.

Como o ColdFusion está sendo executado localmente, o Dreamweaver exibe pacotes de componentes no seu disco rígido.

Use o seguinte procedimento para editar um componente.

Abra qualquer página ColdFusion no Dreamweaver e exiba os componentes no painel Componentes (Janela > Componentes).
Selecione CF Components no menu pop-up do painel e clique no botão Atualizar no painel.

Como o ColdFusion está sendo executado localmente, o Dreamweaver exibe pacotes de componentes no seu disco rígido.

Nota

Para editar visualmente o conjunto de registros CFC, clique duas vezes nele no painel Vínculos.

Para editar um arquivo de componente de forma geral, abra o pacote e clique duas vezes no nome do componente na visualização em árvore.

O arquivo do componente é aberto na Visualização de código.

Para editar uma função, argumento ou propriedade específica, clique duas vezes no item na visualização em árvore.
Faça manualmente as alterações na Visualização de código.
Salve o arquivo (Arquivo > Salvar).
Para ver qualquer nova função no painel Componentes, atualize a exibição clicando no botão Atualizar na barra de ferramentas do painel.

Criar páginas da Web que usam CFCs

Uma forma de usar a função de um componente nas páginas da Web é escrever código na página que invoca a função quando a página é solicitada. Você pode usar o Dreamweaver para ajudar a escrever este código.

Nota

Para outras formas de usar componentes, consulte a documentação do ColdFusion no Dreamweaver (Ajuda > Uso do ColdFusion).

No Dreamweaver, abra a página ColdFusion que usará a função do componente.
Passe para a Visualização de código (Exibir > Código).
Abra o painel Componentes (Janela > Componentes) e selecione CF Components no menu suspenso do painel.
Encontre o componente desejado e insira-o usando uma das seguintes técnicas:
  • Arraste uma função da visualização em árvore para a página.O código é inserido na página para invocar a função.

  • Selecione a função no painel e clique no botão Inserir na barra de ferramentas do painel (o segundo botão da direita).Dreamweaver insere o código na página no ponto de inserção.

Se você inserir uma função que tem argumentos, complete o código do argumento manualmente.

Para obter mais informações, consulte a documentação do ColdFusion de dentro do Dreamweaver (Ajuda > Usando ColdFusion).

Salve a página (Arquivo > Salvar).

Definir um conjunto de registros em um CFC

O Dreamweaver pode ajudar você a definir um conjunto de registros (também conhecido como consulta do ColdFusion) em um CFC. Definindo um conjunto de registros em um CFC, você não precisa definir o conjunto de registros em todas as páginas em que ele é usado. Você define o conjunto de registros uma vez no CFC e usa o CFC em páginas diferentes.

Nota

Esse recurso só está disponível caso você tenha acesso a um computador que esteja executando o ColdFusion MX 7 ou posterior. Para obter mais informações, consulte Ativar os aprimoramentos feitos no ColdFusion.

 

Crie ou abra um arquivo CFC existente no Dreamweaver.
No painel Vínculos (Janela > Vínculos), clique no botão Mais (+) e selecione Conjunto de registros (Consulta) do menu pop-up.

A caixa de diálogo Conjunto de registros é exibida. Você pode trabalhar nas caixas de diálogo de Conjunto de registros simples ou avançadas.

Para usar uma função existente no CFC, selecione a função do menu pop-up Função e pule para a etapa 5.

O conjunto de registros é definido na função.

Para definir uma nova função no CFC, clique no botão Nova função, insira um nome para a função na caixa de diálogo que aparece e clique em OK.

O nome deve conter apenas caracteres alfanuméricos e sublinhados (_).

Para definir um conjunto de registros para a função, complete as opções da caixa de diálogo Conjunto de registros.

A nova função é inserida no CFC que define o conjunto de registros.

Usar um conjunto de registros CFC como uma origem de conteúdo dinâmico

Você pode usar um componente de ColdFusion (CFC) como fonte de conteúdo dinâmico para as páginas caso o componente contenha uma função que define um conjunto de registros.

Nota

Esse recurso só está disponível caso você tenha acesso a um computador que esteja executando o ColdFusion MX 7 ou posterior. Para obter mais informações, consulte Ativar os aprimoramentos feitos no ColdFusion.

Abra uma página do ColdFusion no Dreamweaver.
No painel Vínculos (Janela > Vínculos), clique no botão Mais (+) e selecione Conjunto de registros (Consulta) do menu pop-up.

A caixa de diálogo Conjunto de registros é exibida. Você pode trabalhar na caixa de diálogo de Conjunto de registros simples ou avançada.

Clique no botão Consulta do CFC.
Complete a caixa de diálogo de consulta CFC, clique em OK e clique em OK novamente para adicionar o conjunto de registros CFC à lista de origens de conteúdo disponíveis no painel Vínculos.
Use o painel Vínculos para vincular o conjunto de registros a vários elementos da página.

Para obter mais informações, consulte Adicionar conteúdo dinâmico às páginas.

Definir conteúdo dinâmico usando um CFC

Você pode definir um conjunto de registros como uma origem de conteúdo dinâmico no Dreamweaver usando um CFC que contém uma definição de conjunto de registros.

1.Na caixa Nome, insira um nome para o conjunto de registros CFC.

Uma prática comum é adicionar o prefixo rs aos nomes de conjunto de registros para distingui-los de outros nomes de objeto no código, por exemplo: rsPressRelease.

Os nomes dos conjuntos de registros devem conter apenas caracteres alfanuméricos e sublinhados (_). Você não pode usar caracteres especiais ou espaços.

2.Selecione um pacote dos já definidos no servidor.

Caso o pacote não seja exibido no menu pop-up, você pode atualizar a lista de pacotes clicando no botão Atualizar próximo do menu pop-up.

Primeiramente, verifique se você carregou os CFCs no servidor de teste. Só são exibidos CFCs no servidor de teste.

3.Selecione um componente dos definidos no pacote selecionado atualmente.

Caso o menu pop-up Componente não contenha nenhum componente, ou caso nenhum dos componentes criados anteriormente seja exibido no menu, você deve carregar os arquivos CFC no servidor de teste.

4.(Opcional) Para criar um componente, clique no botão Criar Novo Componente.

a. Na caixa Nome, digite o nome para o novo CFC. O nome deve conter apenas caracteres alfanuméricos e sublinhados (_).

b.Na caixa Diretório do Componente, insira o local do seu CFC ou navegue para localizar a pasta.

Nota

A pasta deve ser o caminho relativo da pasta raiz do site.

5. No menu pop-up Função, selecione a função que contém a definição do conjunto de registros.

O menu pop-up Função contém apenas as funções definidas no componente selecionado no momento. Caso nenhuma função seja exibida no menu pop-up ou caso as alterações mais recentes não sejam refletidas nas funções listadas atualmente, verifique se as alterações foram salvas e carregadas no servidor.

Nota

As caixas Conexão e SQL são somente leitura.

6.Editar cada parâmetro (tipo, valor e valor padrão) que deve ser passado como argumento da função clicando no botão Editar.

a. Insira um valor para o parâmetro atual selecionando o tipo de valor no menu pop-up Valor e inserindo o valor na caixa à direita. O tipo de valor pode ser um parâmetro de URL, uma variável de formulário, um cookie, uma variável de sessão, uma variável de aplicativo ou um valor inserido.

b. Insira um valor padrão para o parâmetro na caixa Valor padrão. Caso nenhum valor de runtime retorne, o valor de parâmetro padrão é usado.

c.Clique em OK. 

Você não pode modificar a conexão de banco de dados e a consulta SQL do conjunto de registros. Esses campos estão sempre desativados; a conexão e a consulta SQL são exibidas para sua informação.

7. Clique em Testar para conectar-se ao banco de dados e criar uma instância do conjunto de registros.

Caso a instrução SQL contenha parâmetros de página, verifique se a coluna Valor padrão da caixa Parâmetros contém valores de teste válidos antes de clicar em Testar.

Caso a consulta tenha sido executada com êxito, uma tabela exibe o conjunto de registros. Cada linha contém um registro e cada coluna representa um campo nesse registro.

Clique em OK para limpar a Consulta do CFC.

8. Clique em OK.