Criando Módulos XOOPS – 01: Fundamentos.

Olá pessoal, vamos começar um "mini curso" sobre criação de módulos para o XOOPS, em vários tutoriais, cada um tratando de características dos recursos disponíveis a serem usados no desenvolvimento de um módulo.

Os temas tratados aqui têm origem nos tutoriais do Kaotik (www.kaotik.biz), da Nave-mãe (dev.xoops.org), materiais esparsos nas comunidades locais dos demais países e nas experiências próprias.

A meta é um tutorial novo por semana, porém já peço as vênias antecipadas caso algum deles não saia exatamente no período semanal.

Para cada tutorial, vamos abrir um tópico no Fórum, para discussões e tirar dúvidas, reservando os comentários do artigo para complementos ao texto, que aproveito para convocar o pessoal que tiver algo a contribuir que o faça também!

Lembramos que o foco deste "mini curso" é criar um módulo Xoops e não as linguagens PHP, MySQL, SMARTY, Javascript ou técnicas de Ajax, mas é claro que para tudo dar certo falaremos disso também, o suficiente para funcionar.

Sem mais delongas, vamos ao assunto:

01: Fundamentos para criação de módulos para XOOPS.

01.1. Inicialmente precisamos preparar o ambiente de desenvolvimento, ou seja, verificar se temos as ferramentas necessárias. Para desenvolver os tutoriais, estarei usando localmente o kit Xampp (Apache, MySql e PHP) em português (apachefriends.org/pt_br/), o XOOPS 2.5.0 (disponível na seção de Downloads aqui no GUX), como editor de código estou usando o Notepad ++, mas podem usar qualquer outro que goste mais.

01.2. O XOOPS é um CMS que se difundiu rápido principalmente pela sua solidez e flexibilidade, principalmente pelo formato modular de fácil e rápido desenvolvimento, como vocês verão.

01.3. Todo módulo XOOPS precisa no mínimo de dois arquivos para funcionar, o famoso xoops_version.php e o index.php.

01.3.1. O arquivo xoops_version.php é o responsável pelas informações necessárias ao XOOPS sobre o funcionamento do módulo a que pertence, dizendo ao core os recursos que ele precisa.

01.3.2. O index.php é o arquivo que o navegador vai procurar para ler, onde deverá estar o código do conteúdo objeto do módulo.

01.4.1. Vamos fazer nosso arquivo xoops_version.php:

a) Vamos até o diretório "..modules" e criamos uma nova pasta com o nome "meumodulo";

b) Abrimos o editor que gostamos e começamos com a abertura do código php "";

c) Sempre entre estes dois comandos incluímos os códigos que trataremos;

d) Neste ponto do tutorial queremos criar o módulo mínimo, portanto digitaremos apenas o seguinte código:

e) Salvamos no diretório "..modulesmeumodulo" com o nome xoops_version.php. Observação: Estou usando palavras acentuadas tanto nos comentários como nas informações, isso porque meu editor já está configurado para o arquivo ser codificado em UTF-8, observe isso no seu editor também.

01.4.2. Agora vamos fazer nosso arquivo index.php:

a) No editor que gostamos e começamos com a abertura do código php ""; (daqui para frente não lembrarei mais deste detalhe)

b) Sempre entre estes dois comandos incluímos os códigos que trataremos; (daqui para frente não lembrarei mais deste detalhe)

c) Precisamos no mínimo chamar o arquivo "mainfile.php" que contém os dados gerais do XOOPS, bem como precisamos chamar os arquivos "header.php" e "footer.php" que criam todo o esquema de funcionamento do XOOPS;

d) E também devemos criar o código próprio do módulo, vejamos:

e) Salvamos no diretório "..modulesmeumodulo" com o nome index.php. e pronto, temos nosso primeiro módulo XOOPS, logo no primeiro tutorial, viram como o XOOPS é fácil e flexível!

01.4.3. Vamos agora até a administração de módulos instalar o nosso mais novo módulo. Vocês perceberão que na lista de módulos a instalar aparecerá apenas o nome "Meu Módulo" e a versão 0, pois fizemos até agora um módulo mínimo.

01.4.4. Vamos até a página inicial e vemos que apareceu mais um link com o nome "Meu Módulo", ao clicar nele vai aparecer o resultado do código incluído no arquivo index.php.

01.5. Mas queremos criar um módulo nos padrões do XOOPS, então vamos modificar algumas linhas dos nossos arquivos já existentes.

01.5.1. Todos os arquivos do XOOPS e dos módulos deve conter os comentário no cabeçalho que especificam dados do arquivo e da licença e sistema a que está vinculado:

01.5.2. O arquivo xoops_version.php também pode conter algumas informações importantes que completam o sistema de controle do módulo, como autor, descrição do módulo, licença, documentação, etc, algo como uma ficha técnica do módulo.

01.5.3. Então o xoops_version.php ficará assim:

01.5.3.1. Detalhe importante, na primeira linha do comentário de cabeçalho consta a informação "v 1.0", vale lembrar que essa informação de versão é a do arquivo e não tem nada a ver com a versão do módulo que está na informação "$modversion['version'] = 1.0".

01.5.3.2. Ainda, na administração o módulo não tem uma imagem, fica aparecendo duas vezes o nome do módulo, então vamos resolvemos isso criando uma imagem para o módulo, no editor de imagem favorito, criamos uma imagem com as dimensões 92x52 pixels e salvamos com o nome "meumodulo_logo.png" dentro do diretório "meumoduloimages" recém criado.

01.5.3.2.1. Para dar uma força, pode copiar a imagem aqui do artigo.

01.5.4. E o arquivo index.php, ficará assim:

01.5.5. Voltamos ao gerenciador de módulos e atualizamos o nosso módulo, para os novos dados passarem a fazer parte do XOOPS.

01.5.6. Pronto, temos um módulo mínimo, com um pouco do padrão do XOOPS já implementado. Nos próximos tutoriais vamos ampliar os códigos destes artigos.

01.6. Não disponibilizei os arquivos com os códigos, pois acredito que digitar os mesmos é uma boa forma de consolidar os conhecimentos, no futuro quando os códigos ficarem mais extensos repensamos essa posição.

01.7. Lembrem que as discussões e dúvidas estão no Fórum, no tópico Criando Módulos Xoops – 01: Fundamentos.