Changes between Version 1 and Version 2 of WF/camadamodel

Timestamp:

07/08/08 17:12:23 (16 years ago)

Author:

viani

Comment:

--

WF/camadamodel

@@ -3 +3 @@
 A camada Model define o que o processo vai fazer e como implementá-lo, ou seja, as regras de negócio do sistema. Ela possibilita o desenvolvimento de recursos, independentemente da forma como os dados serão exibidos (interface) e do momento em que serão executados (fluxo).  Essa camada deve saber somente como executar cada recurso do sistema.
 
-A maneira de representar uma classe model é criando um arquivo no formato class.!AtividadeModel.inc.php, e armazenando este arquivo no diretório 'code' da estrutura de diretórios do processo, semelhante ao que foi feito anteriormente com a camada de Controle. O arquivo deverá conter:
+Assim como na camada de Controle, a camada Model, também é subdivida em três níveis:
+
+ * Nível módulo: representado pela classe !BaseModel;
+ * Nível processo: representado pela classe Model;
+ * Nível atividade: representado pela classe AtividadeModel.
+
+Os três níveis unem-se por herança no seguinte esquema:
+
+ !BaseModel -> Model -> AtividadeModel
+
+A classe !BaseModel está declarada no módulo workflow e vale para todos os processos. Nela estão codificados atributos e métodos de uso geral a serem usados pelas camadas Model das atividades.
+
+Atributos da classe !BaseModel:
+
+ * instance: objeto da instância em execução;
+ * activity: objeto da atividade em execução;
+ * DAO: objeto da camada de abstração de banco de dados;
+ * request: array com os dados submetidos pelo formulário da camada View;
+ * workflow: array com as variáveis do ambiente de execução da atividade;
+ * natural: objeto para conexão com o mainframe;
+ * factory: objeto para a requisição de instâncias das classes auxiliares, como organograma, ldap, etc;
+ * viewData: array contendo os dados a serem exibidos na camada View
+ * Contém atributos privados da camada model;
+ * Contém atributos que representam as propriedades da instância em execução;
+ * Pode conter outros atributos para armazenamento de instâncias de classes de negócio (como paginação, filtros, etc); 
+
+Em especial o atributo viewData, seu objetivo é armazenar os dados a serem retornados para a camada de Controle. Esta é a forma ideal para que um método de negócio da Model faça o retorno de dados.
+
+Os atributos da instância, por padrão, deverão começar com o caracter ''underline'' para diferenciá-los dos atributos privados da classe.
+
+Métodos da classe !BaseModel:
+
+ * getAttributes: retorna os atributos da instância (aqueles iniciados por ''underline'');
+ * getRequest: cria atributos na classe para as variáveis do array Request;
+ * addViewVar: adiciona uma variável ao array viewData;
+ * getViewVar: recupera uma variável do array viewData;
+ * setWfProperty: seta o valor de uma variável do ambiente de execução;
+ * getWfProperty: recupera o valor de uma variável do ambiente;
+ * setNameInstance: seta o valor do identificador da instância;
+ * updateInstance: transfere os atributos de instância que estão na classe para o objeto instance;
+ * updateAttributes: carrega nos atributos de instância da classe os valores que estão no objeto instance;
+ * commitInstance: sinaliza para o módulo workflow que a instância deve ser salva em disco.
+
+
+
+A maneira de representar uma classe model é criando um arquivo no formato class.Atividade.Model.inc.php, e armazenando este arquivo no diretório 'code' da estrutura de diretórios do processo, semelhante ao que foi feito anteriormente com a camada de Controle. O arquivo deverá conter:
 
  * Uma classe com nome no formato !AtividadeModel, que extenda a classe Model do processo;
@@ -260 +305 @@
 ?>
 }}}
-
-46              '''Estrutura:''' 
-47               
-48                * Nível de módulo: 
-49                 * Representado pela classe !BaseModel; 
-50                 * Contém um atributo para armazenamento de instância da classe Instance (!BaseModel::instance); 
-51                 * Contém um atributo para armazenamento de instância da classe Activity (!BaseModel::activity); 
-52                 * Contém um atributo para armazenamento de instância da classe Wf_Db (!BaseModel::DAO); 
-53                 * Contém um atributo para armazenamento de comandos SQL (!BaseModel::commandText); 
-54                 * Contém um atributo para armazenamento de resultados de consultas SQL (!BaseModel::resultSet); 
-55                 * Contém um atributo para armazenamento de registros individuais das consultas SQL (!BaseModel::resultRow); 
-56                 * Contém um atributo para armazenamento do array $_REQUEST (!BaseModel::request); 
-57                 * Contém um atributo para armazenamento de informações sobre o ambiente workflow (!BaseModel::workflow); 
-58                 * Contém um atributo para armazenamento de dados a serem lidos pelo Controller e exibidos na View (!BaseModel::viewData); 
-59                 * Contém atributos para armazenamento de instâncias de classes de negócio (como paginação); 
-60                 * Contém métodos para recuperar e alterar variáveis do ambiente workflow; 
-61                 * Contém métodos de sincronização entre as informações contidas na classe Instance e nos atributos; 
-62                 * Contém método construtor da camada Model (pode ser estendido no nível de processo). 
-63               
-64                * Nível de processo: 
-65                 * Representado pela classe Model; 
-66                 * Contém as informações, representadas na forma de atributos, comuns a todo o processo; 
-67                 * Propaga as informações pelas atividades através da sincronização de seus atributos com a classe Instance do módulo de workflow;