wiki:WF/PadroesdeCodificacaoWorkflow

Padrões de Codificação Workflow

O workflow utiliza a arquitetura de desenvolvimento MVC (veja em Arquitetura de desenvolvimento) e o padrão de codificação descrito em Padrões de Codificação PHP, porém são sugeridas algumas práticas para que o desenvolvimento dos processos sejam padronizados:

Camada Controller

Atributos

Os atributos, com exceção do atributo do nome do template, devem ser escritos em lowerCamelCase. Aquele deve ser escrito em caixa alta separando as palavras com underline (_), como se fosse uma constante.

Métodos

Os métodos que tem relação com MVC devem ser escritos em lowerCamelCase, e devem ser verbos no imperativo, ou seja, salvar, enviar, voltar, carregarDocumento, etc.

Camada Model

Atributos

Os atributos, com exceção dos atributos da instância do processo, deverão ser escritos em lowerCamelCase. Aqueles devem ser escritos em lowerCamelCase prescedidos por underline (_). Isto se deve ao fato de que a engine diferenciará os atributos de instância por esta característica e salvar os dados na execução dos métodos updateInstance() commitInstance() e carregará estes atributos na execução do método updateAtributes(). Para maiores informações veja em Camada de Modelo

Métodos

Os métodos que tem relação com o MVC deverão ser escritos em lowerCamelCase e sucedidos pela palavra 'Action'. Métodos gerais não precisarão seguir esta última regra.

Camada View

A camada view é basicamente constituída dos templates do processo. Estes devem sempre iniciar com o comando smarty {wf_default_template}.