menu

Adianti Framework

Padrões de nomenclatura

Adianti, Framework, PHP, MVC, Active record, Front controller, IDE, RAD, Web, multiplataforma, geração de código, desenvolvimento rápido, relatórios, formulários, listagens, datagrids, gráficos, banco de dados, padrões de projeto, design patterns Regras de nomenclatura para o Adianti Framework.
Adianti Framework
menu Menu
beenhere
Nomenclatura
Padrões de nomenclatura em uma aplicação Adianti Framework.
Livro Adianti Framework
Obra completa sobre o Adianti Framework, escrita pelo criador do framework:
  • check Instalação e configuração; Modelos, persistência e BD;
  • check Componentes de apresentação; Cadastros e listagens;
  • check Logins, permissões, relatórios; Desenvolvimento com Studio Pro.


Boas práticas
  • Nomes de classes:
    • Classes devem ser nomeadas no singular, uma vez que quando instanciadas representam 1 objeto em memória (Ex: new Pessoa, e não new Pessoas);
    • Classes de modelo (Active Records) devem representar entidades. Assim, são melhor representadas por substantivos (Ex: Pessoa, Conta, Compra, Produto, Cliente);
    • Classes controladoras (filhas de TPage) representam o comportamento de uma página. Seu nome geralmente é formado pela Active Record e o tipo de página usada para apresentar a informação (Ex: PessoaForm para formulário de pessoas, e PessoaList para listagem de pessoas);
    • Arquivos que armazenam as classes devem ter exatamente o mesmo nome que a classe (Case Sensitive), com o sufixo .class.php. Assim, se a classe chama-se PessoaForm, seu arquivo deve se chamar PessoaForm.class.php
  • Nomes de métodos:
    • Métodos de classes de modelo (Active Records), devem representar uma ação a ser executada sobre o objeto, que modifica seu estado ou retorna alguma informação (Ex: store(), delete(), getContacts());
    • Métodos de classes de controle (filhas de TPage), devem representar uma ação (evento) a ser executada sobre a página (Ex: onSave(), onDelete(), onReload()), e assim por diante;