Elgg Brasil

Começo hoje uma série de artigos e tutoriais sobre o desenvolvimento de plugins para o Elgg. Entre os temas que serão abordados ao longo das próximas semanas estão: "Criação de Widgets"; "Inserção, edição e exclusão de objetos no banco de dados"; "Desenvolvimento e adaptação de temas"; "Uso de AJAX" e a "Engine do Elgg".

Neste primeiro artigo falarei sobre a estrutura de diretórios que um Plugin pode possuir e qual a função dos principais arquivos.

Reconhecendo um Plugin

No Elgg, um Plugin é apenas uma pasta dentro do diretório "/mod" contendo um arquivo chamado "start.php". O nome do diretório será o nome do plugin, por exemplo, ao construir um plugin de notícias posso criar um diretorio com o nome "noticias".

Possibilidades dos Plugins

No Elgg, um Plugin pode ser desde um tema novo para o site, até um complexo sistema de classificados ou álbum de fotos. Os diretórios irão variar conforme a função do plugin. Neste artigo indicarei apenas os principais arquivos e suas funções.

O Diretório Base

Para fins didáticos utilizarei uma pasta com os seguintes subdiretórios e arquivos.

/nome_plugin
    /actions
    /languages
    /views
        /default
            /nome_qualquer
            /widgets       
    start.php
    mainfest.xml

/actions

Nesta pasta estarão todos os arquivos que inserem, alteram ou excluem registros da base de dados.

/languages

Contém os arquivos referentes às linguagens nas quais o plugin pode ser visualizado.

/views/default

Aqui estarão todos os arquivos que exibem algo ao usuário, podem estar neste diretório o HTML de formulários, telas de listagem, css, javascript. etc.

Pode ser criado qualquer outro diretório que auxilie na organização dos arquivos, como por exemplo um diretório "/form" apenas para as views correspondentes aos formulários. 

/views/widgets

Aqui estarão todas as visualizações que correspondem a Widgets de um determinado plugin.

start.php

Este é o principal arquivo do Plugin, nele serão registradas todas as ações do seu plugin, você poderá adicionar ítens aos menus, indicar configurações, manipular requisições às suas páginas, enfim, absolutamente qualquer coisa que você faça passará por esse arquivo.

manifest.xml

Este arquivo XML contém informações institucionais do Plugin, nome do autor, descrição, página da web, etc.

Conclusão

Neste breve artigo tivemos uma visão bastante breve dos arquivos de um plugin que continuará nos próximos dias.