Framework Miolo

Versão 2.5 - 1 de outubro de 2009
Copyright© 2002-2009 by SOLIS - Cooperativa de Soluções Livres
All Rights Reserved.

Tags

Utilize <?php ... ?>

Identação

Identação padrão utilizando 4 caracteres.
Configurar o editor para substituir o caracter TAB por espaços.

Para configurar o vim/vi:
set expandtab
set shiftwidth=4
set tabstop=4

JEdit:
Global Options->Editing
Tab width: 4
Ident width: 4
Soft tabs

Nomes de constantes

Os nomes de constantes devem ser identificados com todas as letras maiúsculas.
Utilize _ para separar palavras.

Exemplo: $MIOLO->....
$DB_ACAO (onde DB identifica a classe)

Nomes de Variáveis

Os nomes de variáveis devem ser iniciados com letra minúscula, usando a notação camel-case.

Estruturas de Controle

Iniciar o bloco de comandos com '{' na linha após o teste condicional.
Utilizar chaves mesmo quando existir apenas uma instrução.
No caso de teste composto com || e/ou && ... utilizar parênteses para separar os blocos e outro para delimitar todo o conjunto.
Deixar um espaço entre o comando de condicional e o bloco de teste.

if ( (condição1) || (condição2) )
{
ação1;
}
elseif ( (condição3) && (condição4) )
{
ação2;
ação3;
}
else
{
ação4;
}
 switch ( condição )
{
case 1:
ação1;
break;

case 2:
ação2;
break;

default:
ação3;
break;
}

Chamada de Funções

Uma chamada:

$var = funcao($param1, $param2, $param3);

Bloco de chamada de funções (observe o alinhamento):

$var1 = foo($bar);
$variavel2 = foo($rin);

Definição de Funções

Iniciar o bloco de código (chaves) na segunda linha.
O nome da função deve iniciar com letra minúscula e usar a notação camel-case.

function umaFunction($arg1, $arg2 = '')
{
if ( condição )
{
código;
}

return $val;
}
 function connect(&$dsn, $persistent = false)
{
if ( is_array($dsn) )
{
$dsninfo = &$dsn;
}
else
{
$dsninfo = DB::ParseDSN($dsn);
}

if ( (! $dsninfo) || (! $dsninfo['phptype']) )
{
return $this->RaiseError();
}

return true;
}

Comentários

// para uma linha
 //
// para uma linha
//
 //
// esta forma é
// similar à anterior
//
 /*
* outra forma
* para mais de uma linha
*
*/

Inclusão de arquivos

Utilize include_once() e require_once() ao invés de include() e require()

Cabeçalho dos arquivos

// +--------------------------------------------------------------------+
// | Projeto - Projeto Development Team - UNIVATES Centro Universitário|
// +--------------------------------------------------------------------+
// | CopyLeft (L) 2002 UNIVATES, Lajeado/RS - Brasil |
// +--------------------------------------------------------------------+
// | Licensed under GPL: see COPYING.TXT or FSF at www.fsf.org for |
// | further details |
// | |
// | Site: http://projeto.codigolivre.org.br |
// | E-mail: autor@univates.br |
// | |
// +--------------------------------------------------------------------+
// | Abstract: Objetivo deste arquivo... |
// | |
// | Created: aaaa/mm/dd Nome do autor1 |
// | Nome do autor2 |
// | |
// | Id: $Id: CodingStandards.txt,v 1.2 2005/04/03 15:51:42 ematos Exp $
// +--------------------------------------------------------------------+

Ambiente do Miolo

Os programas são criados obedecendo à seguinte estrutura de diretórios:

|
+-modules
|
+-[nome_modulo]
|
+-handlers (manipuladores)
|
+-db (classes Base de Dados)
|
+-etc (arquivos de configuração)
|
+-forms (classes formulários)
|
+-sql (diretório que contém o sql de criação/alteração das bases)
|
+-doc (documentação)
|
+-etc (demais arquivos)

Codificação dos Arquivos

A codificação padrão na versão Miolo 2.5 é UTF-8.