?# Springy
A micro framework for smart PHP developers.
Developer team:
---------------
* 2007 - Fernando Val
### Documentação ###
O sistema MVC deste framework:
------------------------------
Os models (modelos) nada mais são que classes para tratamento de dados ou
funções genéricas ou de uso comum que não fazem parte do cerne do framework.
Nesse framework os models são tratados simplesmento como "classes proprietárias"
e ficam armazenadas no diterório de classes proprietárias (ver estrutura de
diretórios). O framework possui uma classe de tratamento de bancos da qual você
poderá herdar suas classes para tratamento de tabelas em banco, simplesmente
crie suas classes extendendo a classe Springy\Model.
As views (visões), que são o resultado visual do processamento, são tratadas
como templates (modelos) e o desenvolvedor pode optar por utiliza as bibliotecas
[Smarty](http://smarty.net) ou [Twig](http://twig.sensiolabs.org) como
mecanismos de renderização, sendo que os templates Smarty deverão ter a
terminação ".tpl.html" em seus nomes, enquanto para Twig deverão ser terminados
por ".twig.html". Os templates são armazenados no diretório de templates que
pode ter múltiplos níveis de acordo com a necessidade do projeto.
As controladoras são os responsáveis pelo processamento específico de cada
funcionalidade da aplicação e ficam armazenadas no diretório de controladoras
que, assim como o diretório de templates, pode conter múltiplos níveis para
atender às necessidades do projeto.
A estrurura de diretórios do framework:
---------------------------------------
Como todo framework voltado para o desemvolvimento de aplicações para web, o
diretório principal deste framework, é o diretório raiz do site que, no caso do
servidor web Apache (http://www.apache.org) é chamado de DOCUMENT_ROOT.
Dentro do diretório principal, está o script de inicialização e responsável pela
carga da controladora adequado, além da localização e carga das classes
proprietárias e classes do framework que venham a ser utilizadas pela aplicação,
que chamaremos simplemente de "inicializador". No pacote de distribuição, o
inicializador vem denominado _Main.php.
Existe um arquivo index.php, que normalmente é chamado pelo servidor web, mas
este script simplesmente mata a execução do PHP e retorna uma mensagem de acesso
inválido. Isso foi feito pensando que você irá trabalhar com MOD_REWRITE do
Apache. Por esse motivo existe um arquivo .htaccess no diretório raiz da
aplicação.
Tão importante quando o inicializador é o script sysconf.php. Este script é o
primeiro a ser carregado pelo inicializador e sua função é definir as
configurações principais do cerne da aplicação.
A seguir será explicada a função de cada um dos diretórios do framework e, para
isso, será utilizado o nome usado no pacote de distribuição, pois nada impede
que a equipe de desemvolvedores os altere e regonfigure o framework.
Lista padrão de diretórios do framework:
* "app" : é onde estão os subdiretórios da aplicação. Pos questões de seguramça,
recomenda-se que este diretório esteja * fora da árvore navegável da aplicação,
se seu servidor web permitir o acesso a arquivos fora da árvore do www. Neste
caso é necessário ajustar o caminho no arquivo sysconf.php;
* "app/classes" : diretório onde são armazenadas as classes proprietárias;
* "app/controllers" : diretório onde as controladoras são armazenados (pode
conter subdiretórios);
* "app/templates" : diretório onde são asmazenados os templates (pode conter
subdiretórios);
* "conf" : diretório onde são armazenados os scripts de configuração do sistema;
* "springy" : diretório onde estão armazenados as classes e bibliotecas do
framework;
* "var/cache" : diretório onde a classe de templates irá salvar as páginas
cacheadas (o PHP deve ter direito de escrita dentro dele).
* "var/compiled" : diretório onde são asmazenados os templates compilados (o
PHP deve ter direito de escrita dentro dele);
* "vendor" : diretório onde estão armazenados as classes e bibliotecas de
terceiros;
* "www" : é o diretório onde está o inicializador e o sysconf.php. Em alguns
ambientes essa pasta tem nomes como httpdocs ou public_html;
Como o sistema elege um script de controle (controladora):
----------------------------------------------------------
Para determinar qual script de controle será carregado e executado, o sistema se
baseia na URI recebida. Ele desmembra o URI em segmentos e varre o diretório das
controladoras, começando pelo primeiro segmento do URI, da seguinte forma até
que a primeira condição se revele verdadeira:
1. Há um script PHP de nome igual ao segmento:p, acrescido do sufixo ".page";
2. Há um subdiretório de nome igual ao segmento e dentro dele há um script
denominado "index.page" e não mais segmentos.
Se nenhuma das condições acima se mostrarem verdadeiras e houver um subdiretório
de nome igual ao segmento e houver mais algum segmento, o sistema passa para o
próximo segmento e refaz as verificações acima. Isso repete até que um script
seja elegido controladora ou esgotem-se os segmentos do URI.
Caso o sistema tenha eleito uma controladora, ele a carrega para a memória e a
partir daí faz as verificações de exeção da controladora (veja o próximo
capítulo).
Não havendo uma controladora eleita, a página de erro 404 é mostrada.
Script de inicialização (bootstrap):
------------------------------------
Antes de construir a controladora e fazer a chamada de seus métodos, o framework
verifica a existência do script bootstrap.php, no diretório da aplicação. Caso
esse arquivo exista, será carregado e executado. Este script serve como um
inicializador que sempre é executado antes de qualquer controladora ser
carregada.
A controladora e seus métodos:
------------------------------
Eleito a controladora, o sistema cria uma classe com seu nome (o script é
carregado automaticamente pelo sistema). Consequentemente o PHP irá executar o
método construtor da classe, que poderá ser usado pela equipe de desenvolvimento
para inicializar a variáveis ou até mesmo executar a principal ação da
controladora, caso este não possua um método para o tratamento do segmento de
URI seguinte (como veremos a seguir).
Tendo sucesso ao carregar a controladora, o sistema verifica se há segmento de
URI seguinte e em caso afirmativo, busca por um método de nome igual a este
segmento. Havendo este médoto, o executa.
Caso a condição anterior não aconteça, o sistema procura pelo método _default e
o executa, se existir.
Fim do processamento:
---------------------
Após os métodos da controladora terminarem sua execução e devolverem o controle
para o inicializador, este faz os tratamentos finais e encerra a aplicação.
Está previsto para uma versão futura do framework o desenvolvimento de um hook
de finalização a ser executado antes do sistema terminar.
A biblioteca de classes:
------------------------
O framework já possuiu uma série de classes que podem ser utilizadas pela equipe
de programadores a fim de facilitar e agilizar o desenvolvimento do projeto.
Para uma listagem completa das classes da biblioteca, acesse a documentação do
framework no seguinte endereço: http://framework.fval.net.br
Direitos Autorais e Propriedade Intelectual:
--------------------------------------------
Este framework é distribuído sob licença MIT.
Para detalhes de como utilizar esse framework, entre em contato com os autores.
Histórico:
----------
Veja o arquivo history.txt
|
Download
