Joomla.com.br

Como são organizados os arquivos no Joomla! 1.5

(arquivo original: How Joomla! 1.5 Files are Organised, http://www.theartofjoomla.com)

Joomla! 1.5 tem muitas semelhanças com Joomla! 1.0 em termos de estrutura de arquivo e, também, muitas diferenças. Neste artigo abordaremos algumas das maiores diferenças de maneira bem simples.

Quando você descompacta o Joomla! os diretórios iniciais se apresentam da seguinte maneira:

/administrator
/cache
/components
/images
/includes
/installation
/language
/libraries
/logs
/media
/modules
/plugins
/templates
/tmp
/xmlrpc

Há algumas coisas a observar aqui:

• O diretório mambots foi renomeado para plugins (esta é uma das maiores terminologias alteradas no Joomla! 1.5). O formato dos sub-diretórios continuam o mesmo, onde os plugins são agrupados em áreas tais como conteúdo, sistema, etc.
• Existe um novo diretório chamado libraries. Neste estão muitos dos API e bibliotecas de terceiros que estavam antes sob a pasta /includes/.
• Existe um novo diretório /media/ que contém os arquivos relacionados às interfaces dos usuários, tais como algumas bibliotecas em javascript, arquivos flash, etc.
• O diretório /help/ foi movido para a área do administrador.
• O diretório legado /editor/ directory foi removido.
• Existe um novo diretório /xmlrpc/ para o suporte de serviços web via protocolo XML-RPC.

Um dos mais interessantes diretórios para se estudar é o /library/. Você encontrará muitos nomes familiares de scripts de terceiros, tais como /phpgacl/, /phpmailer/, /geshi/ e outros. Também encontrará alguns novos como /simplepie/ e um diretório interessante chamado /joomla/.

Virtualmente todo o API central do Joomla! API foi movido de um conjunto de arquivos (nomeando /includes/joomla.php e outros) em /libraries/joomla/. Este é agora a "espinha dorsal" do Joomla! Quase todas as classes residem em seus próprios arquivos em uma hierarquia lógica. Por exemplo, o administrador do banco de dados mysql pode ser encontrado em /libraries/joomla/database/database/mysql.php. Navegando por outros diretórios você encontrará muitos nomes não familiares. Não se preocupe, vamos abordar o que está acontecendo aqui em futuros artigos.

Há duas outras mudanças que queremos abordar, que terão grande impacto para desenvolvedores e designers.

A primeira grande mudança foi a re-estruturação dos componentes de frontend (frontend = área de visualização do site > área normalmente acessada) em um formato MVC ("Model-View Controller" > arquitetura de controle de visualização por modelo). A estrutura de diretório é geralmente algo como o apresentado abaixo:

/com_content
/helpers
/models
/views
/article
/tmpl

Existem poucos arquivos nesses diretórios, mas falaremos sobre eles em outra oportunidade.O mais importante nesse momento é entender o relacionamento entre os diretórios do sistema de menu do Joomla! e também o do sistema de templates. Deve existir também, um diretório /controllers/ dependendo da complexidade do componente (e a preferência pessoal do desenvolvedor - veja a nota para mais observações sobre a terminologia do MVC).

Cada diretório sob a pasta /views/ é geralmente habilitada para ser chamada a partir de uma URL. Por exemplo index.php?option=com_content&view=article&id=1

Assumimos que aquele componente sabe o que fazer com o id, mas esta url procurará na pasta /views/article/ por informações sobre como apresentar a página. Quando você acrescenta um novo item de menu a partir da área de administração, você verá um lista de componentes e ao selecionar um, verá todas as visualizações listadas. Estas são automaticamente retiradas do gerenciador de menu, o que foi um grande melhoramento do Joomla! 1.0 onde essas opções eram difíceis de serem alteradas. Em muitos casos você verá muitas outras opções de seleção e essas são chamadas de leiautes. Esses leiautes residem no diretório /views/view_name/tmpl/ e estes são (geralmente) o único lugar onde códigos HTML são apresentados.

E isto nos traz ao nosso segundo ponto. Joomla! 1.0 tem uma maneira de mudar a saída de um componente - mas para ser honesto ela não é muito bem conhecida e nunca foi uma solução que funcionasse bem ou subsistisse a atualizações dos arquivos centrais. Joomla! 1.5 mudou isto. Como todo componente de frontend tem o seu código HTML em arquivos de leiautes, Joomla! deu-lhe a possibilidade de alterar esses arquivos individualmente no template ativo.

Para ver um exemplo disso, dê uma olhada no template Beez. Você verá um novo diretório chamado /html/.

/html
/com_content
/article
/mod_login

Ambos, componentes e módulos, podem ter leiautes sobrescritos.

No caso de componentes, você deve fazer uma árvore de diretório começando como o nome do componente (o mesmo que é encontrado no diretório /components/), o nome da pasta de visualização, e, finalmente, você inclui um arquivo php com o mesmo nome do arquivo de leiaute que você deseja mudar.

No caso dos Módulos é o mesmo, com exceção de que eles não possuem visualizações, apenas o leiaute para mudar (alguns desenvolvedores de terceiros disponibilizam diferentes leiautes para os módulos, o que é um ótimo recurso).

Tudo o que você precisa se lembar é combinar o componente com o nome do módulo, combinar o nome da visualização para os componentes, então combinar o nome do arquivo do leiaute. è realmente muito simples. Apresentaremos maiores detalhes em outra oportunidade sobre sinalizações de visualizações e leiautes.

Nota - Como os arquivos são organizados

Devido a saída

Não há garantias de que o patTemplate sob a pasta /libraries/ não seja suportada em versões futuras. Enquanto o sistema de instalação ainda o executa, o restante do Joomla! estará se movendo para uma arquitetura de Model-View_Controller (MVC > controle de visualização por modelo) é emprega um sistema de template baseado em PHP muito leve e simples. Enquanto que o patTemplate tecnicamente honra a intenção de um MVC (como a visualização não pode autorizada a modificar os dados que ela provê), e a sua sintaxe é muito amigável, ela possui sérios problemas quando necessita construir loops aninhados, etc. Mudando para um sistema PHP, o designer é permitido máxima flexibilidade na comunicação com os dados de visualização assim como o resto da API.

A biblioteca DOMIT XML está sendo progressivamente planejada em fases. Joomla! 1.5 provê uma nova classe simples chamada de JSimpleXML para controlar muitas das necessidades na leitura de arquivos XML. Assim como outros projetos, Joomla! está se movendo para o PHP 5 e então será capaz de empregar os recursos do novo XML daquela versão para suportar operações XML de novo jeito.

J-isto e J-aquilo

Para aqueles que não podem esperar para esmiuçar a nova API, as muitas das classes que são empregadas chamadas de mosSomething ou josSomething foram alteradas para simplesmente JSomething. Muitas funções também foram transformadas em classes. Por exemplo, mosReadDirectory é agora suportada por dois métodos de classes: JFolder::arquivos e JFolder::diretórios.

Tão fácil quanto no M-V-C

Tudo do frontend do Joomla! foi convertido para o formato MVC. Contudo, alguns dos componentes de administração foram convertidos. Para um exemplo simples de um components de admnistração tipo MVC veja Weblinks ou para um de implementação mais complexa veja os Componentes de Menus.

Controller - Controlador - este é um arquivo que controla todas as tarefas de um componente.

Model - Modelo - um modelo é responsável pelo controle de toda lógica do negócio associada ao componente. Ele é responsável por recuperar os dados de um banco de dados.

View - Visualização - uma visualização é responsável pela montagem dos dados a serem apresentados.

Layout - Leiaute - um leiaute é um arquivo que realmente apresenta os códigos HTML baseados nos dados disponíveis na visualização.

Substituição de Template

O template "Beez" provê um exemplo extensivo de como substituir/mudar também cada aspecto do frontend do Joomla! e provê uma solução de template que atenda aos padrões de acessibilidade.