Detalhes

Categoria: Joomla

Atualização: Terça, 21 Abril 2009 21:22

Autor: vovó Vicki

Acessos: 33197

O arquivo helper.php

O arquivo helper.php contém a classe helper que é usada para obter dados que serão mostrados na saída do módulo. Como já foi dito anteriormente, nossa classe helper terá apenas um método: getOla(). Este método retorna a mensagem 'Olá, receba as boas vindas'.

Aqui está o código:

Não existe uma regra que diz como dar um nome a uma classe helper, mas é bom fazê-lo como no exemplo porque fica mais fácil saber do que se trata e de identificar e localizar o que queremos.

Módulos mais sofisticados podem incluir solicitações ao banco de dados e outras funcionalidades nos métodos da classe helper.

:info: Observe que a palavra "Olá" está escrita de uma forma estranha. É que o "á" precisa ser definido em UTF-8, o padrão do Joomla.

O arquivo tmpl/default.php

O arquivo default.php é um modelo (template) que mostra a saída do módulo. O código é o seguinte:

É importante saber que o arquivo template tem o mesmo escopo que o arquivo mod_boasvindas.php. Isto significa que a variável $ola pode ser definida no arquivo mod_boasvindas.php e depois ser usada no arquivo default.php sem qualquer declaração extra ou chamada a funções.

O arquivo mod_boasvindas.xml

O mod_boasvindas.xml é usado para especificar quais arquivos o instalador precisa copiar e é usado pelo Module Manager (Administrador de Módulos) para determinar quais parâmetros são usados para configurar o módulo. Outras informações sobre o módulo também são especificadas neste arquivo.

O código de mod_boasvindas.xml é o seguinte:

:info: ATENÇÃO: Não use vogais acentuadas ou letras do ASCII expandido (tipo ç ou Ç) neste arquivo xml. O Joomla vai estrilar dizendo que NÃO ENCONTRA O ARQUIVO DE INSTALAÇÃO simplesmente porque não reconhece estes caracteres. Ou você deixa todos os acentos e c cedilhas de lado, ou os substitua pelos equivalentes em UTF-8. Observe que qo invés de "vovó Vicki" usei "vovo Vicki" :smile:

Não é por nada não, mas é que já me embananei mais de uma vez com este negócio de UTF-8. Espero que você não caia na mesma armadilha..."

Você deve ter notado que existem dois arquivos adicionais que ainda não foram mencionados: index.html e tmpl/index.html. Estes arquivos são incluídos para que estes diretórios não possam ser listados. Se um usuário tentar acessar estes diretórios através do navegador, receberá uma página em branco porque os arquivos index.html possuem apenas uma única linha:

Como o módulo não usa parâmetros, esta seção está vazia.

Pacote de instalação

Crie um diretório chamado mod_boasvindas. Coloque os arquivos mod_boasvindas.php, index.html e helper.php neste diretório. Crie um subdiretório chamado tmpl. Neste subdiretório coloque os arquivos default.php e index.html. A seguir, faça um pacote zip do diretório mod_boasvindas. Isto é tudo: o mod_boasvindas.zip é o pacote de instalação que o Joomla 1.5 espera receber para instalar o módulo.

Desejo sucesso a todos vocês!

:vovo: vovó Vicki

Referência

• Creating a Hello World Module for Joomla 1.5, exemplo dado no Wiki de Documentação do Developer Net.