2010 Solis Cooperativa de Solues Livres

Manual de Instalao
e Configurao
do Miolo

Equipe Miolo
miolo@solis.coop.br

ndice
1 Introduo.......................................................................................................................................3
1.1 Arquivos importantes...........................................................................................................3
2 Instalao........................................................................................................................................4
2.1 Pacote de instalao.............................................................................................................4
2.2 Repositrio.............................................................................................................................4
2.2.1 Pr-requisitos.................................................................................................................4
2.2.2 Miolo................................................................................................................................4
3 Configurao..................................................................................................................................6
3.1 configure.................................................................................................................................6
3.2 setconfig..................................................................................................................................6
3.3 getconfig.................................................................................................................................6
3.4 removeconfig.........................................................................................................................6
3.5 createmodule.........................................................................................................................7
3.6 createhandler.........................................................................................................................7
3.7 createform..............................................................................................................................7
3.8 createsearchform..................................................................................................................7
3.9 creategrid................................................................................................................................8
3.10 createbusiness.....................................................................................................................8
3.11 createmvc..............................................................................................................................8
3.12 createtheme.........................................................................................................................8
3.13 start........................................................................................................................................8
3.14 translate................................................................................................................................9
3.15 help........................................................................................................................................9

1 Introduo
O Miolo um framework para desenvolvimento de aplicaes Web. Desenvolvido
na linguagem PHP e utilizando conceitos de programao orientada a objetos, o Miolo
visa facilitar a programao de sistemas Web atravs de classes e da abstrao de
camadas comuns nesse tipo de sistema, como segurana, gerao de HTML e conexo
com a base de dados.
Na seo a seguir so explicados alguns arquivos importantes para o
entendimento do Miolo.

1.1 Arquivos importantes

Handler: Arquivo responsvel pela chamada aos formulrios, grids e outros
componentes para exib-los na pgina.
MForm: Classe que representa um formulrio.
MGrid: Classe utilizada para exibir os dados de uma tabela.
MBusiness: Classe utilizada para representar uma tabela da base de dados.
Para mais informaes sobre o Miolo, consulte os documentos presentes no
repositrio oficial:
https://svn.solis.coop.br/miolo/branches/2.5-stable/docs/

No captulo 2 explicado como instalar o Miolo e o captulo 3 explica o utilitrio

de configurao do Miolo. Os passos descritos nesse manual devem ser executados em
um terminal (linha de comando) do Linux.

2 Instalao
A instalao do Miolo pode ser feita de duas formas: atravs do pacote de
instalao do Ubuntu ou atravs do repositrio Subversion.

2.1 Pacote de instalao

Caso a distribuio utilizada seja Ubuntu, faa o download do pacote atravs do
seguinte link:
https://svn.solis.coop.br/miolo/branches/2.5/package/ubuntu/miolo_2.5_i386.deb

Em seguida, basta clicar duas vezes no arquivo e seguir os passos, ou ento

executar o seguinte comando.
$ gdeb miolo_2.5_i386.deb

Agora o Miolo est instalado e pronto para ser acessado atravs do seu
navegador pela URL a seguir:
http://miolo.localhost/

2.2 Repositrio
Caso utilize outra distribuio, o Miolo pode ser obtido atravs do repositrio
Subversion. Dessa forma devem ser realizadas algumas configuraes de forma manual.

2.2.1 Pr-requisitos
Para a instalao e utilizao do Miolo so necessrias algumas ferramentas,
cujas instalaes no so foco desse manual. So elas:

Apache
PHP
Subversion

2.2.2 Miolo
Escolha um diretrio para armazenar seus projetos. Certifique-se que voc se
encontra no diretrio desejado e faa o download da verso 2.5 do Miolo, utilizando o
Subversion.
$ cd /home/usuario/projetos
$ svn co https://svn.solis.coop.br/miolo/branches/2.5 miolo25

No servidor Apache deve ser adicionado um Virtual Host para o diretrio do

Miolo, conforme exemplo abaixo.

<VirtualHost *:80>
ServerAdmin admin@miolo.org.br
ServerName miolo.org.br
DocumentRoot /home/usuario/projetos/miolo25/html
<Directory /home/usuario/projetos/miolo25/html>
Options Indexes FollowSymLinks MultiViews
AllowOverride None
Order allow,deny
Allow from all
</Directory>
</VirtualHost>

Utilize o utilitrio do Miolo para realizar sua configurao inicial, informando a

URL escolhida, no caso http://miolo.org.br. Todas as funcionalidades desse utilitrio so
explicadas no captulo 3 .
$ cd miolo25
$ bin/miolo.php configure http://miolo.org.br

Agora o Miolo est configurado e pronto para ser acessado atravs do seu
navegador pela URL informada.

3 Configurao
Para a configurao do Miolo, existe um utilitrio em linha de comando, o qual
pode ser encontrado no diretrio bin no diretrio raiz do Miolo. Seus comandos e sua
interface de ajuda esto em ingls. Neste manual esto descritas suas funcionalidades
em portugus.
Sintaxe de utilizao a partir da raiz:
$ bin/miolo.php <comando> [<parmetros>]

3.1 configure
Cria um arquivo inicial de configurao. Modo de uso:
$ bin/miolo.php configure [url]

3.2 setconfig
Define o valor do parmetro de configurao (miolo.conf). Espera pelo menos
dois parmetros, o nome do parmetro de configurao e o novo valor a atribuir a esse
parmetro.
O parmetro de configurao utiliza o caractere '.' como separador.
O terceiro parmetro no obrigatrio. Com ele pode ser definido que a
configurao a ser atlerada especfica do mdulo (module.conf).
Modo de uso:
$ bin/miolo.php setconfig <configurao> <valor> [mdulo]

3.3 getconfig
Obtm o valor da configurao do Miolo (miolo.conf). Caso um mdulo seja
informado, obtm o valor da configurao do mdulo (module.conf).
Modo de uso:
$ bin/miolo.php getconfig <configurao> [mdulo]

3.4 removeconfig
Remove a configurao informada do arquivo de configurao (miolo.conf).
Remove a configurao do mdulo caso ele seja informado (module.conf).

Modo de uso:
$ bin/miolo.php removeconfig <configurao> [mdulo]

3.5 createmodule
Cria um mdulo com o nome informado, gerando uma estrutura inicial bsica
(MVC). Como segundo parmetro pode ser informado o mdulo no qual o novo deve se
basear, ou seja, ser feita uma cpia do base_module, alterando apenas seu nome.
Modo de uso:
$ bin/miolo.php createmodule <mdulo> [mdulo_base]

3.6 createhandler
Cria um arquivo handler no mdulo informado. O parmetro <handler> o nome
do handler, <ttulo> o texto a ser exibido na barra de navegao e <formulrio> o
nome do formulrio a ser exibido pelo handler.
Modo de uso:
$ bin/miolo.php createhandler <mdulo> <handler> <ttulo> <formulrio>

3.7 createform
Cria um formulrio no mdulo informado. O parmetro <formulrio> define o
nome da classe e <ttulo> define o ttulo do formulrio.
Modo de uso:
$ bin/miolo.php createform <mdulo> <formulrio> <ttulo>

3.8 createsearchform
Cria um formulrio de busca no mdulo informado, ou seja, cria uma tela para
exibio dos registros de uma tabela, com possibilidade de filtr-los.
O parmetro <formulrio> define o nome da classe, <ttulo> define o ttulo do
formulrio, <grid> o nome da classe MGrid a ser utilizada para exibio dos dados,
<tabela> o nome da tabela na base de dados cujos dados devem ser exibidos.
Opcionalmente tambm podem ser informados os filtros, os quais devem ser os nomes
das colunas da tabela separados por espao.
Modo de uso:

$ bin/miolo.php createsearchform <mdulo> <formulrio> <ttulo> <grid> <tabela> [filtro1 ...

filtroN]

3.9 creategrid
Cria uma grid no mdulo informado. O parmetro <grid> define o nome da classe
e <ttulo> define o ttulo da grid. Os parmetros opcionais a seguir informam os nomes
das colunas da grid.
Modo de uso:
$ bin/miolo.php creategrid <mdulo> <grid> <ttulo> [coluna1 ... colunaN]

3.10 createbusiness
Cria um objeto no mdulo informado, representando uma dada tabela da base
dados, a qual contm apenas um mtodo de busca.
Modo de uso:
$ bin/miolo.php createbusiness <mdulo> <table>

3.11 createmvc
Cria uma estrutura MVC funcional no mdulo informado. A estrutura composta
por um handler; um business; um formulrio de busca; um formulrio de gerenciamento
para inserir, remover, editar registros, uma grid e uma base dados sqlite j populada.
Modo de uso:
$ bin/miolo.php createmvc <mdulo>

3.12 createtheme
Cria um novo tema baseado em um tema existente. Modo de uso:
$ bin/miolo.php createtheme <nome> <tema_base>

3.13 start
Cria uma nova instalao do Miolo utilizando a mesma cpia base do Miolo.
Recebe por parmetro o diretrio onde deve ser criada essa nova instalao. Modo de
uso:
$ bin/miolo.php start <path>

3.14 translate
Utilitrio de traduo. Espera pelo menos um parmetro, podendo ser extract ou
generate. O primeiro realiza a extrao dos textos no traduzidos e os pe nos arquivos
com extenso .po no diretrio misc/i18n/ para ser feita a traduo.
$ bin/miolo.php translate extract

Em seguida, deve ser utilizado o comando generate para efetuar a compilao dos
arquivos de traduo. Para visualizar os novos textos na sua aplicao, deve-se reinicar o
Apache aps esse comando.
$ bin/miolo.php translate generate

3.15 help
Exibe os comandos suportados pela ferramenta. Tambm pode ser obtida a ajuda
especfica de cada comando, passando-o por parmetro.
Modo de uso:
$ bin/miolo.php help [comando]